Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 1.83 KB

README.md

File metadata and controls

46 lines (27 loc) · 1.83 KB
Raw

Sinon.JS

Build status

Standalone and test framework agnostic JavaScript test spies, stubs and mocks.

Installation

via npm (node package manager)

$ npm install sinon

via NuGet (package manager for Microsoft development platform)

Install-Package SinonJS

or install via git by cloning the repository and including sinon.js in your project, as you would any other third party library.

Don't forget to include the parts of Sinon.JS that you want to use as well (i.e. spy.js).

Usage

See the sinon project homepage for documentation on usage.

If you have questions that are not covered by the documentation, please post them to the Sinon.JS mailinglist or drop by #sinon.js on irc.freenode.net:6667

Important: AMD needs pre-built version

Sinon.JS as source doesn't work with AMD loaders (when they're asynchronous, like loading via script tags in the browser). For that you will have to use a pre-built version. You can either build it yourself or get a numbered version from http://sinonjs.org.

This might or might not change in future versions, depending of outcome of investigations. Please don't report this as a bug, just use pre-built versions.

Goals

  • No global pollution
  • Easy to use
  • Require minimal “integration”
  • Easy to embed seamlessly with any testing framework
  • Easily fake any interface
  • Ship with ready-to-use fakes for XMLHttpRequest, timers and more

Contribute?

See CONTRIBUTING.md for details on how you can contribute to Sinon.JS