2016-03-09 11:51:06 +00:00
[![Chai Documentation ](http://chaijs.com/img/chai-logo.png )](http://chaijs.com)
2011-12-15 12:50:06 +00:00
2016-03-09 11:51:06 +00:00
< br >
2015-03-15 22:03:18 +00:00
[![tag:? ](https://img.shields.io/github/tag/chaijs/chai.svg?style=flat-square )](https://github.com/chaijs/chai/releases)
[![build:? ](https://img.shields.io/travis/chaijs/chai/master.svg?style=flat-square )](https://travis-ci.org/chaijs/chai)
2016-03-09 11:28:15 +00:00
[![Average time to resolve an issue ](http://isitmaintained.com/badge/resolution/chaijs/chai.svg )](http://isitmaintained.com/project/chaijs/chai "Average time to resolve an issue")
[![Percentage of issues still open ](http://isitmaintained.com/badge/open/chaijs/chai.svg )](http://isitmaintained.com/project/chaijs/chai "Percentage of issues still open")
2015-03-15 22:03:18 +00:00
[![coverage:? ](https://img.shields.io/coveralls/chaijs/chai/master.svg?style=flat-square )](https://coveralls.io/r/chaijs/chai)< br >
[![npm: ](https://img.shields.io/npm/v/chai.svg?style=flat-square )](https://www.npmjs.com/packages/chai)
2016-03-09 11:51:06 +00:00
[![license:mit ](https://img.shields.io/badge/license-mit-green.svg?style=flat-square )](#license)
2015-03-15 22:03:18 +00:00
[![dependencies:? ](https://img.shields.io/npm/dm/chai.svg?style=flat-square )](https://www.npmjs.com/packages/chai)
[![devDependencies:? ](https://img.shields.io/david/chaijs/chai.svg?style=flat-square )](https://david-dm.org/chaijs/chai)
[![Selenium Test Status ](https://saucelabs.com/browser-matrix/chaijs.svg )](https://saucelabs.com/u/chaijs)
2015-12-09 15:17:18 +00:00
[![Slack Status ](https://chai-slack.herokuapp.com/badge.svg )]( https://chai-slack.herokuapp.com/)
[![Join the chat at https://gitter.im/chaijs/chai ](https://badges.gitter.im/Join%20Chat.svg )](https://gitter.im/chaijs/chai)
2016-06-20 19:46:24 +00:00
[![OpenCollective ](https://opencollective.com/chaijs/backers/badge.svg )](#backers)
[![OpenCollective ](https://opencollective.com/chaijs/sponsors/badge.svg )](#sponsors)
2015-03-15 22:03:18 +00:00
2011-12-16 11:57:51 +00:00
Chai is a BDD / TDD assertion library for [node ](http://nodejs.org ) and the browser that
2011-12-16 11:15:30 +00:00
can be delightfully paired with any javascript testing framework.
2012-05-15 18:27:49 +00:00
For more information or to download plugins, view the [documentation ](http://chaijs.com ).
2012-05-09 18:45:45 +00:00
2014-03-19 16:22:08 +00:00
### Plugins
Chai offers a robust Plugin architecture for extending Chai's assertions and interfaces.
- Need a plugin? View the [official plugin list ](http://chaijs.com/plugins ).
- Want to build a plugin? Read the [plugin api documentation ](http://chaijs.com/guide/plugins/ ).
2016-04-01 09:36:07 +00:00
- 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
2014-03-19 16:22:08 +00:00
2013-06-17 20:06:38 +00:00
### Related Projects
2013-09-18 19:04:00 +00:00
- [chaijs / assertion-error ](https://github.com/chaijs/assertion-error ): Custom `Error` constructor thrown upon an assertion failing.
2014-01-26 06:35:09 +00:00
- [chaijs / deep-eql ](https://github.com/chaijs/deep-eql ): Improved deep equality testing for Node.js and the browser.
2015-06-03 22:36:25 +00:00
- [chaijs / type-detect ](https://github.com/chaijs/type-detect ): Improved typeof detection for node.js and the browser.
2013-06-17 20:06:38 +00:00
2015-07-17 15:40:14 +00:00
### 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 ](https://github.com/chaijs/chai/blob/master/CONTRIBUTING.md#pull-requests ) them.
We also strongly encourage you to read our detailed [contribution guidelines ](https://github.com/chaijs/chai/blob/master/CONTRIBUTING.md ).
2012-05-09 18:45:45 +00:00
### Contributors
2012-02-13 19:03:34 +00:00
2015-06-03 22:36:25 +00:00
Please see the full
[Contributors Graph ](https://github.com/chaijs/chai/graphs/contributors ) for our
list of contributors.
### Core Contributors
2015-10-10 00:43:25 +00:00
Feel free to reach out to any of the core contributors with your questions or
2015-06-03 22:36:25 +00:00
concerns. We will do our best to respond in a timely manner.
[![Jake Luer ](https://avatars3.githubusercontent.com/u/58988?v=3&s=50 )](https://github.com/logicalparadox)
[![Veselin Todorov ](https://avatars3.githubusercontent.com/u/330048?v=3&s=50 )](https://github.com/vesln)
[![Keith Cirkel ](https://avatars3.githubusercontent.com/u/118266?v=3&s=50 )](https://github.com/keithamus)
2016-03-11 22:57:39 +00:00
[![Lucas Fernandes da Costa ](https://avatars3.githubusercontent.com/u/6868147?v=3&s=50 )](https://github.com/lucasfcosta)
2016-06-14 13:49:45 +00:00
[![Grant Snodgrass ](https://avatars3.githubusercontent.com/u/17260989?v=3&s=50 )](https://github.com/meeber)
2011-12-15 12:50:06 +00:00
2016-06-20 19:46:24 +00:00
### Backers
Support us with a monthly donation and help us continue our activities. [[Become a backer ](https://opencollective.com/chaijs#backer )]
< a href = "https://opencollective.com/chaijs/backer/0/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/1/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/2/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/3/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/4/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/5/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/6/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/7/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/8/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/9/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/9/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/10/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/10/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/11/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/11/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/12/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/12/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/13/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/13/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/14/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/14/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/15/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/15/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/16/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/16/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/17/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/17/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/18/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/18/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/19/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/19/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/20/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/20/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/21/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/21/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/22/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/22/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/23/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/23/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/24/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/24/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/25/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/25/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/26/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/26/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/27/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/27/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/28/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/28/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/backer/29/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/backer/29/avatar.svg" > < / a >
### 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 ](https://opencollective.com/chaijs#sponsor )]
< a href = "https://opencollective.com/chaijs/sponsor/0/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/1/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/2/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/3/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/4/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/5/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/6/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/7/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/8/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/9/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/9/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/10/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/10/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/11/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/11/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/12/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/12/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/13/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/13/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/14/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/14/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/15/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/15/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/16/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/16/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/17/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/17/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/18/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/18/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/19/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/19/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/20/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/20/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/21/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/21/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/22/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/22/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/23/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/23/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/24/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/24/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/25/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/25/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/26/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/26/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/27/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/27/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/28/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/28/avatar.svg" > < / a >
< a href = "https://opencollective.com/chaijs/sponsor/29/website" target = "_blank" > < img src = "https://opencollective.com/chaijs/sponsor/29/avatar.svg" > < / a >
2011-12-15 12:50:06 +00:00
## License
(The MIT License)
2015-02-01 03:33:52 +00:00
Copyright (c) 2011-2015 Jake Luer < jake @ alogicalparadox . com >
2011-12-15 12:50:06 +00:00
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
2012-01-25 22:10:16 +00:00
THE SOFTWARE.