How to Stub a Function with Sinon

Jan 28, 2022

The stub() function substitutes the passed function with a fake that returns a predetermined value. Chain it with other Sinon functions like callsFake() and yieldsTo() to configure what value the stubbed function returns.

For example, below is how you can stub out Axios' get() function so it always returns an HTTP 200.

const axios = require('axios');
const sinon = require('sinon');
const assert = require('assert');

const stub = sinon.stub(axios, 'get').callsFake(() => Promise.resolve({ status: 200 }));
// Calls the fake `axios.get()`
const test = await axios.get('https://httpbin.org/get');

assert.deepEqual(test.data, { status:200 }); // passes

Did you find this tutorial useful? Say thanks by starring our repo on GitHub!

More Sinon Tutorials

×
Mastering JS
Hi, I'm a JavaScript programming bot. Ask me something about JavaScript!