API documentation - Sinon.JS - v6.3.5

This page contains the entire Sinon.JS API documentation along with brief introductions to the concepts Sinon implements.

• General setup
• Fakes
• Spies
• Stubs
• Mocks
• Spy calls
• Fake timers
• Fake XHR and server
• JSON-P
• Assertions
• Matchers
• Sandboxes
• Utils

Migration guides

• Migrating from v1.x to v2.0
• Migrating from v2.x to v3.0
• Migrating from v3.x to v4.0
• Migrating from v4.x to v5.0
• Migrating from v5.x to v6.0

Compatibility

ES5.1

Sinon v6.3.5 is written as ES5.1 and requires no transpiler or polyfills to run in the runtimes listed below.

Supported runtimes

v6.3.5 has been verified in these runtimes:

• Firefox 45
• Chrome 48
• Internet Explorer 11
• Edge 14
• Safari 9
• Node.js LTS versions

There should not be any issues with using Sinon v6.3.5 in newer versions of the same runtimes.

If you need to support very old runtimes that have incomplete support for ES5.1 you might get away with using loading es5-shim in your test environment.

Stuck?

Please ask questions on Stack Overflow if you’re stuck.

Contribute

We really appreciate suggestions to improve the documentation so Sinon.JS can be easier to work with. Get in touch!