# delta-e

> CIE color difference algorithms in JavaScript.

Latest version **0.0.8** (published 2020-06-21) · 0 weekly downloads

## Install

```sh
npm install delta-e
pnpm add delta-e
yarn add delta-e
bun add delta-e
```

## Health

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

Positive: has types package; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2020-06-21 |
| First published | 2014-11-16 |
| Weekly downloads | 0 |
| TypeScript types | separate (@types/delta-e) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 43.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 273 |
| Maintainers | zschuess |
| Keywords | cie, cie94, cie76, color difference, color algorithm, delta e |

## Links

- npm: https://www.npmjs.com/package/delta-e
- Repository: https://github.com/zschuessler/DeltaE
- Homepage: https://github.com/zschuessler/DeltaE#readme
- Issues: https://github.com/zschuessler/DeltaE/issues
- npm.io page: https://npm.io/package/delta-e

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 0.0.8 (latest) — 2020-06-21
- 0.0.7 — 2015-04-01
- 0.0.6 — 2015-04-01
- 0.0.5 — 2015-04-01
- 0.0.4 — 2015-04-01
- 0.0.3 — 2015-03-24
- 0.0.1 — 2014-11-16

## README

# DeltaE - Quantify Color Difference

Check out the following GitHub Pages respository for information on this library.

http://zschuessler.github.io/DeltaE/

## About Delta E

This package gives access to three color difference algorithms. 
These algorithms represent the hard work of the [International Commission on Illumination (CIE).](http://www.cie.co.at/)


Historically, each iterative algorithm has been used in print
and textile industries to maintain consistency in machine calibration.
These days, far more interesting use cases arise with media processing.
    
## Install It

DeltaE comes in flavors of npm and Bower.

    // install via npm
    npm install delta-e

    // install via Bower
    bower install delta-e

### Use It
    // For npm: use require
    var DeltaE = require('delta-e');

    // For Bower: include the script. DeltaE global now accessible.
    <script src="bower_components/delta-e/dist/deltae.global.min.js"></script>

    // Create two test LAB color objects to compare!
    var color1 = {L: 36, A: 60, B: 41};
    var color2 = {L: 100, A: 40, B: 90};
    
    // 1976 formula
    console.log(DeltaE.getDeltaE76(color1, color2));
    
    // 1994 formula
    console.log(DeltaE.getDeltaE94(color1, color2));
    
    // 2000 formula
    console.log(DeltaE.getDeltaE00(color1, color2));

## Tests

A simple Mocha test is setup to test the accuracy of each dE algorithm, for both
npm and Bower versions.

    $ cd tests/
    $ mocha main.js

## Gulp Tasks

### build

Builds both the Bower and npm version from source.

    $ gulp build

### jsdoc

Generates full documentation in the /jsdoc/ folder.

    $ gulp jsdoc

## Licensing

This is Unlicensed. Do what you want. Just don't sue me, and we is cool.

> This is free and unencumbered software released into the public domain.
>
> Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
>
> In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
>
> 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 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.
>
> For more information, please refer to <http://unlicense.org>

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