# chai-things

> Chai Things adds support to [Chai](http://chaijs.com/) for assertions on array elements.

Latest version **0.2.0** (published 2013-04-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install chai-things
pnpm add chai-things
yarn add chai-things
bun add chai-things
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2013-04-05 |
| First published | 2013-01-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/chai-things) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 105 |
| Author | Ruben Verborgh |
| Maintainers | rubenverborgh |

## Links

- npm: https://www.npmjs.com/package/chai-things
- Repository: https://github.com/RubenVerborgh/Chai-Things
- Issues: https://github.com/RubenVerborgh/Chai-Things/issues
- npm.io page: https://npm.io/package/chai-things

## Recent versions

- 0.2.0 (latest) — 2013-04-05
- 0.1.2 — 2013-03-25
- 0.1.1 — 2013-01-09
- 0.1.0 — 2013-01-09
- 0.0.1 — 2013-01-08

## README

# Chai Things
Chai Things adds support to [Chai](http://chaijs.com/) for assertions on array elements.

## Examples

### Something
Use the `something` property on an array to test whether the assertion holds for one of its elements.

```javascript
// Although they are equal, two different { a: 'cat' } objects are not the same
[{ a: 'cat' }, { a: 'dog' }].should.not.include({ a: 'cat' })
// Chai Things allows us to test deep equality on one of the elements
[{ a: 'cat' }, { a: 'dog' }].should.include.something.that.deep.equals({ a: 'cat' })
// If the test fails, we get a descriptive message
[{ a: 'cat' }, { a: 'dog' }].should.include.something.that.deep.equals({ a: 'cow' })
/* expected an element of [ { a: 'cat' }, { a: 'dog' } ] to deeply equal { a: 'cow' } */
```

You are free to choose the syntactic variant you like most:

```javascript
[4, 11, 15].should.include.one.below(10)
[4, 11, 15].should.contain.some.above(10)
[4, 11, 15].should.not.contain.any.above(20)
[{ a: 'cat' }, { a: 'dog' }].should.contain.a.thing.with.property('a', 'cat')
[{ a: 'cat' }, { a: 'dog' }].should.contain.an.item.with.property('a', 'dog')
```

### All
Use the `all` property on an array to test whether the assertion holds for all its elements.

```javascript
// All items are below 20
[4, 11, 15].should.all.be.below(20)
// All items have a property 'a'
[{ a: 'cat' }, { a: 'dog' }].should.all.have.property('a')
// If the test fails, we get a descriptive message
[4, 11, 15].should.all.be.above(20)
/* expected all elements of [ 4, 11, 15 ] to be above 20 */
[{ a: 'cat' }, { a: 'dog' }].should.all.have.property('a', 'cat')
/* expected all elements of [ { a: 'cat' }, { a: 'dog' } ] to have a property 'a' of 'cat', but got 'dog' */
```

There are currently no syntactic variants for `all`. Let me know if you need them.


## Installation and usage
```bash
$ npm install chai-things
```

```javascript
var chai = require("chai");
chai.should();
chai.use(require('chai-things'));
```

---
_Source: https://npm.io/package/chai-things · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._