# ntcjs

> A Node CommonJS compatible wrapper for the Name That Color library (ntc js) - http://chir.ag/projects/ntc/

Latest version **1.1.3** (published 2023-04-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install ntcjs
pnpm add ntcjs
yarn add ntcjs
bun add ntcjs
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2023-04-09 |
| First published | 2017-08-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 59 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Petar Bojinov |
| Maintainers | pbojinov |
| Keywords | name, that, color, hex, rgb, hue, ntc, ntc.js |

## Links

- npm: https://www.npmjs.com/package/ntcjs
- Repository: https://github.com/pbojinov/name-that-color
- Homepage: https://github.com/pbojinov/name-that-color#readme
- Issues: https://github.com/pbojinov/name-that-color/issues
- npm.io page: https://npm.io/package/ntcjs

## 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

- 1.1.3 (latest) — 2023-04-09
- 1.1.2 — 2017-08-02
- 1.0.2 — 2017-08-02
- 1.0.1 — 2017-08-02

## README

# Name That Color

A Node CommonJS compatible wrapper for the Name That Color library (ntc js) - http://chir.ag/projects/ntc/

## Installation

```
npm install ntcjs --save
```

## Getting Started

```javascript
const ntc = require('ntcjs');

const n_match = ntc.name('#6195ED');
n_rgb = n_match[0]; // RGB value of closest match
n_name = n_match[1]; // Text string: Color name
n_exactmatch = n_match[2]; // True if exact color match

console.log(n_match); // [ '#6495ED', 'Cornflower Blue', false ]
```

## Live Demo

This is a live demo of the original ntcjs library

http://chir.ag/projects/name-that-color/#6195ED

## Running the Tests

Make sure you install the necessary dev dependencies needed to run the tests:

```
npm install
```

Then run the tests

```
npm test
```

## Disclaimer

All credit goes to [Chirag Mehta](http://chir.ag/about) for creating the original ntc.js library.

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