# colour-proximity

> Get a value of the proximity of two hex colours.

Latest version **0.0.2** (published 2013-08-24) · GPLv3 license · 49 weekly downloads

## Install

```sh
npm install colour-proximity
pnpm add colour-proximity
yarn add colour-proximity
bun add colour-proximity
```

## 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.0.2 |
| Published | 2013-08-24 |
| First published | 2013-08-21 |
| Weekly downloads | 49 |
| License | GPLv3 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Gausie |
| Maintainers | gausie |
| Keywords | color, colour, proximity, closeness, similarity, L*a*b*, Lab |

## Links

- npm: https://www.npmjs.com/package/colour-proximity
- Repository: https://github.com/gausie/colour-proximity
- Issues: https://github.com/gausie/colour-proximity/issues
- npm.io page: https://npm.io/package/colour-proximity

## Dependencies (1)

- [color-string](https://npm.io/package/color-string.md) ~0.1.2

## 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.2 (latest) — 2013-08-24
- 0.0.1 — 2013-08-21

## README

# colour-proximity

Get a value of the proximity of two hex colours.

This package also exports `rgb2lab([r,g,b])`, a function that converts RGB to L*a*b* at Observer=2° and Illuminant=D65

## Example

```javascript
colour-proximity.proximity("#ffffff","#fffffe")	// 0.5074219151751335
colour-proximity.proximity("#ffffff","#000000")	// 100.000000625
```

## Install

Use [node](http://nodejs.org) with [npm](http://npmjs.org):

	npm install colour-proximity

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