chai/README.md

[](https://github.com/chaijs/chai/releases) [](https://travis-ci.org/chaijs/chai) [](http://isitmaintained.com/project/chaijs/chai "Average time to resolve an issue") [](http://isitmaintained.com/project/chaijs/chai "Percentage of issues still open") [](https://coveralls.io/r/chaijs/chai)
[](https://www.npmjs.com/packages/chai) [](#license) [](https://www.npmjs.com/packages/chai) [](https://david-dm.org/chaijs/chai)

Chai is a BDD / TDD assertion library for node and the browser that can be delightfully paired with any javascript testing framework.

For more information or to download plugins, view the documentation.

Plugins

Chai offers a robust Plugin architecture for extending Chai's assertions and interfaces.

• Need a plugin? View the official plugin list.
• Want to build a plugin? Read the plugin api documentation.
• Have a plugin and want it listed? Simply add the following keywords to your package.json:
  • chai-plugin
  • browser if your plugin works in the browser as well as Node.js
  • browser-only if your plugin does not work with Node.js

Related Projects

• chaijs / assertion-error: Custom Error constructor thrown upon an assertion failing.
• chaijs / deep-eql: Improved deep equality testing for Node.js and the browser.
• chaijs / type-detect: Improved typeof detection for node.js and the browser.

Contributing

Thank you very much for considering to contribute!

Here are a few issues other contributors frequently ran into when opening pull requests:

• Please do not commit changes to the chai.js build. We do it once per release.
• Before pushing your commits, please make sure you rebase them.

We also strongly encourage you to read our detailed contribution guidelines.

Contributors

Please see the full Contributors Graph for our list of contributors.

Core Contributors

Feel free to reach out to any of the core contributors with your questions or concerns. We will do our best to respond in a timely manner.

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

Sponsors

Become a sponsor and get your logo on our website and on our README on Github with a link to your site. [Become a sponsor]

License

(The MIT License)

Copyright (c) 2011-2015 Jake Luer jake@alogicalparadox.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.