# @types/color-diff

> TypeScript definitions for color-diff

Latest version **1.2.5** (published 2023-11-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/color-diff
pnpm add @types/color-diff
yarn add @types/color-diff
bun add @types/color-diff
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.5 |
| Published | 2023-11-20 |
| First published | 2019-01-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/color-diff
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/color-diff
- npm.io page: https://npm.io/package/@types/color-diff

## Recent versions

- 1.2.5 (latest) — 2023-11-20
- 1.2.2 (ts4.3) — 2023-09-04
- 1.2.1 (ts3.6) — 2021-07-08
- 1.2.0 (ts3.5) — 2021-03-25
- 1.1.0 (ts2.7) — 2019-01-26
- 1.2.4 — 2023-11-07
- 1.2.3 — 2023-10-18

## README

# Installation
> `npm install --save @types/color-diff`

# Summary
This package contains type definitions for color-diff (https://github.com/markusn/color-diff#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/color-diff.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/color-diff/index.d.ts)
````ts
export interface RGBColor {
    R: number;
    G: number;
    B: number;
    A?: number | undefined;
}

export interface LabColor {
    L: number;
    a: number;
    b: number;
}

export function diff(c1: LabColor, c2: LabColor): number;

export function rgb_to_lab(c: RGBColor): LabColor;
export function rgba_to_lab(c: RGBColor, bc?: RGBColor): LabColor;
export function normalize_rgb(c: RGBColor): RGBColor;

export function closest(
    color: RGBColor,
    palette: readonly RGBColor[],
    backgroundColor?: RGBColor,
): RGBColor;

export function furthest(
    color: RGBColor,
    palette: readonly RGBColor[],
    backgroundColor?: RGBColor,
): RGBColor;

export function map_palette(
    a: readonly RGBColor[],
    b: readonly RGBColor[],
    type?: "closest" | "furthest",
    backgroundColor?: RGBColor,
): { [key: string]: RGBColor };

export function palette_map_key(c: RGBColor): string;

export function closest_lab(
    color: LabColor,
    palette: readonly LabColor[],
): LabColor;

export function furthest_lab(
    color: LabColor,
    palette: readonly LabColor[],
): LabColor;

export function map_palette_lab(
    p1: readonly LabColor[],
    p2: readonly LabColor[],
): { [key: string]: LabColor };

export function lab_palette_map_key(c: LabColor): string;

export function match_palette_lab(
    target_color: LabColor,
    palette: readonly LabColor[],
    find_furthest: boolean,
): LabColor;

````

### Additional Details
 * Last updated: Mon, 20 Nov 2023 23:36:24 GMT
 * Dependencies: none

# Credits
These definitions were written by [katsanva](https://github.com/katsanva).

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