+{"_id":"@joethefkingfrypan/sinon-chai","name":"@joethefkingfrypan/sinon-chai","dist-tags":{"latest":"3.6.0-rc1"},"versions":{"3.6.0-rc1":{"name":"@joethefkingfrypan/sinon-chai","description":"Extends Chai with assertions for the Sinon.JS mocking framework.","keywords":["chai","chai-plugin","browser","vendor","mocks-and-spies","sinon","testing","spies","stubs","mocks"],"version":"3.6.0-rc1","author":{"name":"Domenic Denicola","email":"d@domenic.me","url":"https://domenic.me/"},"contributors":[{"name":"Simon de Lang","email":"simondelang@gmail.com"}],"license":"(BSD-2-Clause OR WTFPL)","repository":{"type":"git","url":"git+https://github.com/domenic/sinon-chai.git"},"main":"./lib/sinon-chai.js","scripts":{"test":"mocha","test-travis":"npm install && npm install chai@$CHAI_VERSION && npm install sinon@$SINON_VERSION && npm test","lint":"eslint .","cover":"nyc --reporter=html mocha && opener ./coverage/sinon-chai.js.html"},"peerDependencies":{"chai":"^4.0.0","sinon":">=4.0.0 <10.0.0"},"devDependencies":{"chai":"^4.2.0","eslint":"^6.8.0","mocha":"^7.0.1","nyc":"^15.0.0","opener":"^1.5.1","sinon":"^9.0.0"},"gitHead":"71adb7a600c7c71a082343a4f50c0d8159bbb1c3","bugs":{"url":"https://github.com/domenic/sinon-chai/issues"},"homepage":"https://github.com/domenic/sinon-chai#readme","_id":"@joethefkingfrypan/sinon-chai@3.6.0-rc1","_nodeVersion":"14.16.0","_npmVersion":"7.6.3","dist":{"integrity":"sha512-N/H//zl2lXkjT596rUsH6qGSxgTK+Q039vUB17lUkUhGSYMEmOnzPdpHksCq7t89gDxbMaK1vrkYrBZaGJw0BA==","shasum":"49f5c27c2b3f9daca85dd61dc2ebfe41713e29c5","tarball":"https://registry.npmjs.org/@joethefkingfrypan/sinon-chai/-/sinon-chai-3.6.0-rc1.tgz","fileCount":5,"unpackedSize":17055,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgVJpACRA9TVsSAnZWagAAITsP/1AcBvsbefwQvM7WNN30\nXTiGGj/13QEBbWaUP2VUcOFGGLvmWgq18vqrrectXdjCWisg7lk7IPTRtuoC\nQiiCVSTMg2ofosZHWAgC7GIV8/si+D9QpvYK00Wh/M9jFpWtu/nsLwsBxOOO\nxl1iCfjI6AzetfnuY+WUJezyp/tHaK6Tps5SJ8HU+ILLMHWpl4dDp0P9irmm\nSYgnjm7R9qDMX1L98tf/fVcMUPqwm4tUrpE2n0051Mh+un8vWb+1vYVMNOtP\nE4Stt3wNL+tXV8jdMWIbxLbnSq1pbuXs4kEhejeY0SsAKNMTstJNUH32bkEz\nbru6e4n2Yu88XSD0+0nGSF/dYwkK9q+H5HdDa5+C/3hvBjOs2MwnXr2VGwwm\n/jGnbI5j4WjjJi8HrB86JNFyO5FJBsYcnRF90/fbXAS6rOMD09WjnkXwIpq/\nEpg2Mo9/fLFda3z7rr2S6LD0Qjc4YvyWZdAbGb/qJxiS6ZrKDXx67AMRIb1G\n+b/sWKqKF4QP9AkEWGaYiOt5/0AgTLcVgd3YgF5lmTNqsU9VgPwh7gEvGR7P\nU7DY2l04tWMaLlBL+VG/VvivpcQgN1KXb74LOM5LJZtPe47NxWJl6yMwYu2O\nqUTLfLKSJFiYVL7tacXHtSCq282nRk2NvsBwqJ/VzSCvawlbSLf3lUr8uWMt\nwDEo\r\n=wi1x\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"joethefkingfrypan","email":"romgagnaire@gmail.com"},"directories":{},"maintainers":[{"name":"joethefkingfrypan","email":"romgagnaire@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sinon-chai_3.6.0-rc1_1616157247895_0.31494147285411933"},"_hasShrinkwrap":false}},"time":{"created":"2021-03-19T12:34:07.854Z","3.6.0-rc1":"2021-03-19T12:34:08.009Z","modified":"2021-03-19T12:34:11.731Z"},"maintainers":[{"name":"joethefkingfrypan","email":"romgagnaire@gmail.com"}],"description":"Extends Chai with assertions for the Sinon.JS mocking framework.","homepage":"https://github.com/domenic/sinon-chai#readme","keywords":["chai","chai-plugin","browser","vendor","mocks-and-spies","sinon","testing","spies","stubs","mocks"],"repository":{"type":"git","url":"git+https://github.com/domenic/sinon-chai.git"},"contributors":[{"name":"Simon de Lang","email":"simondelang@gmail.com"}],"author":{"name":"Domenic Denicola","email":"d@domenic.me","url":"https://domenic.me/"},"bugs":{"url":"https://github.com/domenic/sinon-chai/issues"},"license":"(BSD-2-Clause OR WTFPL)","readme":"# Sinon.JS Assertions for Chai\n\n**Sinon–Chai** provides a set of custom assertions for using the [Sinon.JS][] spy, stub, and mocking framework with the\n[Chai][] assertion library. You get all the benefits of Chai with all the powerful tools of Sinon.JS.\n\nInstead of using Sinon.JS's assertions:\n\n```javascript\nsinon.assert.calledWith(mySpy, \"foo\");\n```\n\nor awkwardly trying to use Chai's `should` or `expect` interfaces on spy properties:\n\n```javascript\nmySpy.calledWith(\"foo\").should.be.ok;\nexpect(mySpy.calledWith(\"foo\")).to.be.ok;\n```\n\nyou can say\n\n```javascript\nmySpy.should.have.been.calledWith(\"foo\");\nexpect(mySpy).to.have.been.calledWith(\"foo\");\n```\n\n## Assertions\n\nAll of your favorite Sinon.JS assertions made their way into Sinon–Chai. We show the `should` syntax here; the `expect`\nequivalent is also available.\n\n| Sinon.JS property/method | Sinon–Chai assertion |\n|--------------------------|-------------------------------------------------------------------|\n| called | spy.should.have.been.called |\n| callCount | spy.should.have.callCount(n) |\n| calledOnce | spy.should.have.been.calledOnce |\n| calledTwice | spy.should.have.been.calledTwice |\n| calledThrice | spy.should.have.been.calledThrice |\n| calledBefore | spy1.should.have.been.calledBefore(spy2) |\n| calledAfter | spy1.should.have.been.calledAfter(spy2) |\n| calledImmediatelyBefore | spy.should.have.been.calledImmediatelyBefore(spy2) |\n| calledImmediatelyAfter | spy.should.have.been.calledImmediatelyAfter(spy2) |\n| calledWithNew | spy.should.have.been.calledWithNew |\n| alwaysCalledWithNew | spy.should.always.have.been.calledWithNew |\n| calledOn | spy.should.have.been.calledOn(context) |\n| alwaysCalledOn | spy.should.always.have.been.calledOn(context) |\n| calledWith | spy.should.have.been.calledWith(...args) |\n| alwaysCalledWith | spy.should.always.have.been.calledWith(...args) |\n| calledOnceWith | spy.should.always.have.been.calledOnceWith(...args) |\n| calledWithExactly | spy.should.have.been.calledWithExactly(...args) |\n| alwaysCalledWithExactly | spy.should.always.have.been.calledWithExactly(...args) |\n| calledOnceWithExactly | spy.should.always.have.been.calledOnceWithExactly(...args) |\n| calledWithMatch | spy.should.have.been.calledWithMatch(...args) |\n| alwaysCalledWithMatch | spy.should.always.have.been.calledWithMatch(...args) |\n| returned | spy.should.have.returned(returnVal) |\n| alwaysReturned | spy.should.have.always.returned(returnVal) |\n| threw | spy.should.have.thrown(errorObjOrErrorTypeStringOrNothing) |\n| alwaysThrew | spy.should.have.always.thrown(errorObjOrErrorTypeStringOrNothing) |\n\nFor more information on the behavior of each assertion, see\n[the documentation for the corresponding spy methods][spymethods]. These of course work on not only spies, but\nindividual spy calls, stubs, and mocks as well.\n\nNote that you can negate any assertion with Chai's `.not`. E. g. for `notCalled` use `spy.should.have.not.been.called`.\n\nFor `assert` interface there is no need for this library. You can install [Sinon.JS assertions][sinonassertions] right into Chai's `assert` object with `expose`:\n\n```javascript\nvar chai = require(\"chai\");\nvar sinon = require(\"sinon\");\n\nsinon.assert.expose(chai.assert, { prefix: \"\" });\n```\n\n## Examples\n\nUsing Chai's `should`:\n\n```javascript\n\"use strict\";\nvar chai = require(\"chai\");\nvar sinon = require(\"sinon\");\nvar sinonChai = require(\"sinon-chai\");\nchai.should();\nchai.use(sinonChai);\n\nfunction hello(name, cb) {\n cb(\"hello \" + name);\n}\n\ndescribe(\"hello\", function () {\n it(\"should call callback with correct greeting\", function () {\n var cb = sinon.spy();\n\n hello(\"foo\", cb);\n\n cb.should.have.been.calledWith(\"hello foo\");\n });\n});\n```\n\nUsing Chai's `expect`:\n\n```javascript\n\"use strict\";\nvar chai = require(\"chai\");\nvar sinon = require(\"sinon\");\nvar sinonChai = require(\"sinon-chai\");\nvar expect = chai.expect;\nchai.use(sinonChai);\n\nfunction hello(name, cb) {\n cb(\"hello \" + name);\n}\n\ndescribe(\"hello\", function () {\n it(\"should call callback with correct greeting\", function () {\n var cb = sinon.spy();\n\n hello(\"foo\", cb);\n\n expect(cb).to.have.been.calledWith(\"hello foo\");\n });\n});\n```\n\n## Installation and Usage\n\n### Node\n\nDo an `npm install --save-dev sinon-chai` to get up and running. Then:\n\n```javascript\nvar chai = require(\"chai\");\nvar sinonChai = require(\"sinon-chai\");\n\nchai.use(sinonChai);\n```\n\nYou can of course put this code in a common test fixture file; for an example using [Mocha][], see\n[the Sinon–Chai tests themselves][fixturedemo].\n\n### AMD\n\nSinon–Chai supports being used as an [AMD][] module, registering itself anonymously (just like Chai). So, assuming you\nhave configured your loader to map the Chai and Sinon–Chai files to the respective module IDs `\"chai\"` and\n`\"sinon-chai\"`, you can use them as follows:\n\n```javascript\ndefine(function (require, exports, module) {\n var chai = require(\"chai\");\n var sinonChai = require(\"sinon-chai\");\n\n chai.use(sinonChai);\n});\n```\n\n### `<script>` tag\n\nIf you include Sinon–Chai directly with a `<script>` tag, after the one for Chai itself, then it will automatically plug\nin to Chai and be ready for use. Note that you'll want to get the latest browser build of Sinon.JS as well:\n\n```html\n<script src=\"chai.js\"></script>\n<script src=\"sinon-chai.js\"></script>\n<script src=\"sinon.js\"></script>\n```\n\n### Ruby on Rails\n\nThanks to [Cymen Vig][], there's now [a Ruby gem][] of Sinon–Chai that integrates it with the Rails asset pipeline!\n\n\n[Sinon.JS]: http://sinonjs.org/\n[Chai]: http://chaijs.com/\n[spymethods]: http://sinonjs.org/docs/#spies-api\n[sinonassertions]: http://sinonjs.org/docs/#assertions\n[Mocha]: https://mochajs.org/\n[fixturedemo]: https://github.com/domenic/sinon-chai/tree/master/test/\n[AMD]: https://github.com/amdjs/amdjs-api/wiki/AMD\n[Cymen Vig]: https://github.com/cymen\n[a Ruby gem]: https://github.com/cymen/sinon-chai-rails\n","readmeFilename":"README.md"}
0 commit comments