README.md
# jest-matcher-one-of
[](https://travis-ci.org/d4nyll/jest-matcher-one-of)
[](https://codecov.io/gh/d4nyll/jest-matcher-one-of)
[](https://codeclimate.com/github/d4nyll/jest-matcher-one-of/test_coverage)
[](https://www.codefactor.io/repository/github/d4nyll/jest-matcher-one-of)
[](https://www.codacy.com/app/d4nyll/jest-matcher-one-of?utm_source=github.com&utm_medium=referral&utm_content=d4nyll/jest-matcher-one-of&utm_campaign=Badge_Grade)
[](https://codeclimate.com/github/d4nyll/jest-matcher-one-of/maintainability)
[](https://snyk.io/test/github/d4nyll/jest-matcher-one-of)
[](https://greenkeeper.io/)
A Jest matcher (`toBeOneOf`) to test if a value is one of many (like enums).
## Installation
1. Add the package
```sh
yarn add jest-matcher-one-of --dev
npm install jest-matcher-one-of --save-dev
```
2. Require the package at the root of your test files
```js
require('jest-matcher-one-of');
import 'jest-matcher-one-of'; // Using ES6 w/ Babel or TypeScript
```
## Usage
```js
expect(1).toBeOneOf([1, 2]);
expect(1).not.toBeOneOf([2, 3, 4]);
expect(1).toBeOneOf(1); // Also forgiving for non-array values
```
## Contributing
Get the source code and run the tests.
```sh
$ git clone git@github.com:d4nyll/jest-matcher-one-of.git
$ yarn # or npm install
$ yarn test # or npm test
```