# jest-color
> A bundle of Jest matchers for testing and asserting colors
Latest version **0.1.0** (published 2019-08-18) · MIT license · 0 weekly downloads
## Install
```sh
npm install jest-color
pnpm add jest-color
yarn add jest-color
bun add jest-color
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-08-18 |
| First published | 2019-08-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 17.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Mathspy |
| Maintainers | mathspy |
| Keywords | jest, matchers, color, testing |
## Links
- npm: https://www.npmjs.com/package/jest-color
- Repository: https://github.com/Mathspy/jest-color
- Homepage: https://github.com/Mathspy/jest-color#readme
- Issues: https://github.com/Mathspy/jest-color/issues
- npm.io page: https://npm.io/package/jest-color
## Dependencies (3)
- [color](https://npm.io/package/color.md) ^3.1.2
- [color-diff](https://npm.io/package/color-diff.md) ^1.1.0
- [jest-matcher-utils](https://npm.io/package/jest-matcher-utils.md) ^24.8.0
## Alternatives
- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads
## Recent versions
- 0.1.0 (latest) — 2019-08-18
## README
jest-color
🃏🎨
A bundle of Jest matchers for testing and asserting colors
[](https://dev.azure.com/mathspy257/jest-color/_build/latest?definitionId=1&branchName=master)
[](https://www.npmjs.com/package/jest-color)
[](http://npm-stat.com/charts.html?package=jest-color&from=2019-08-17)
[](https://github.com/mathspy/jest-color/blob/master/LICENSE)
[](http://makeapullrequest.com)
## Problem
Testing colors with Jest is not simple. It should be as easy as `.toBeColor`
## Solution
jest-color aims to add additional matchers to Jest's default ones that does just that
## Contributing
If you've come here to help contribute - Sweet! Thanks! Take a look at the [contributing](/CONTRIBUTING.md) and read the [Code of Conduct](/CODE_OF_CONDUCT.md) docs as a way of getting started!
---
- [Problem](#problem)
- [Solution](#solution)
- [Contributing](#contributing)
- [Installation](#installation)
- [Setup](#setup)
- [Asymmetric matchers](#asymmetric-matchers)
- [API](#api)
- [.toBeColor(color)](#tobecolorcolor)
- [expect.color(color)](#expectcolorcolor)
- [.toBeIndistinguishableFrom(color)](#tobeindistinguishablefromcolor)
- [expect.indistinguishableFrom(color)](#expectindistinguishablefromcolor)
- [LICENSE](#license)
## Installation
With npm:
```sh
npm install -D jest-color
```
With yarn:
```sh
yarn add -D jest-color
```
## Setup
### Jest >v24
Add `jest-color` to your Jest `setupFilesAfterEnv` configuration. [See for help](https://jestjs.io/docs/en/configuration.html#setupfilesafterenv-array)
```json
"jest": {
"setupFilesAfterEnv": ["jest-color"]
}
```
## Asymmetric matchers
All matchers described below have asymmetric variants. Example:
```js
test("symmetric vs asymmetric", () => {
expect("#7db2ceff").toBeColor(125, 178, 206);
expect("#7db2ceff").toEqual(expect.color(125, 178, 206));
});
```
## API
#### .toBeColor(object)
Accepts anything that [`color`](https://www.npmjs.com/package/color) accepts and compares them to one another. It must be the exact same color.
```js
expect("#7db2ceff").toBeColor(125, 178, 206); // true
expect("#72510e").toBeColor(114, 81, 14, 1); // true
expect([157, 204, 97]).toBeColor("#9dcc61"); // true
expect("hwb(60, 3%, 60%)").toBeColor("rgb(102, 102, 8)"); // true
expect("#cccc0866").toBeColor("hwb(60, 3%, 20%, 0.4)"); // true
expect("hsla(114, 60%, 39%, 0.32)").toBeColor([52, 159, 40, 0.32]); // true
expect("#7db2caaa").not.toBeColor(125, 178, 202); // true
```
#### expect.color(color)
The asymmetric variant of `.toBeColor`.
```js
expect("#7db2ceff").toEqual(expect.color(125, 178, 206)); // true
expect("#72510e").toEqual(expect.color(114, 81, 14, 1)); // true
expect([157, 204, 97]).toEqual(expect.color("#9dcc61")); // true
expect("hwb(60, 3%, 60%)").toEqual(expect.color("rgb(102, 102, 8)")); // true
expect("#cccc0866").toEqual(expect.color("hwb(60, 3%, 20%, 0.4)")); // true
expect("hsla(114, 60%, 39%, 0.32)").toEqual(expect.color([52, 159, 40, 0.32])); // true
expect("#7db2caaa").toEqual(expect.not.color(125, 178, 202)); // true
```
#### .toBeIndistinguishableFrom(color)
Also accepts anything that [`color`](https://www.npmjs.com/package/color) accepts. It compares them using ~~THE POWER OF SCIENCE~~ [CIEDE2000](https://en.wikipedia.org/wiki/Color_difference#CIEDE2000) and if the [Delta E is less than 1](http://zschuessler.github.io/DeltaE/learn/#toc-delta-e-2000) it returns true.
```js
```
#### expect.indistinguishableFrom(color)
The asymmetric variant of `.toBeIndistinguishableFrom`.
```js
expect([50, 158, 38]).toEqual(expect.indistinguishableFrom(49, 155, 37)); // true
expect([217, 223, 214]).toEqual(
expect.indistinguishableFrom("rgb(216, 222, 215)"),
); // true
expect("hwb(110, 84%, 13%)").toEqual(
expect.indistinguishableFrom("hwb(111, 84%, 13%)"),
); // true
```
## LICENSE
[MIT](/LICENSE)
---
_Source: https://npm.io/package/jest-color · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._