API documentation - Sinon.JS - v18.0.1

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
• Promises
• 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 and supported runtimes

As of Sinon 10 we stopped maintaining compatibility with legacy browsers. Instead, we focus on compatibility with evergreen browsers, Node.js LTS versions and recent Safari versions. The most up-to-date reference on which runtimes and browsers we support can be found by looking at our compatibility docs.

If you need to support old runtimes you can try Sinon 9.

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!