# pixcolor

> A small nodejs utility to get the color of a pixel on the desktop screen.

Latest version **1.0.0** (published 2019-01-27) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-01-27 |
| First published | 2019-01-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Kyle Kemp |
| Maintainers | seiyria |
| Keywords | pixel, color, desktop, screen, pixcolor |

## Links

- npm: https://www.npmjs.com/package/pixcolor
- Repository: https://github.com/seiyria/pixcolor
- Homepage: https://github.com/seiyria/pixcolor#readme
- Issues: https://github.com/seiyria/pixcolor/issues
- npm.io page: https://npm.io/package/pixcolor

## Dependencies (1)

- [edge-js](https://npm.io/package/edge-js.md) ^11.3.0

## 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.0.0 (latest) — 2019-01-27

## README

# pixcolor
A small nodejs utility to get the color of a pixel on the desktop screen.

## Usage

`npm i pixcolor`

```js
import pixcolor from pixcolor;

// synchronous usage
const color = pixcolor([100, 200], true);

// async usage
pixcolor([100, 200], (err, color) => {

});
```

The return value will be in the format `RRGGBB` like a hex color, but it doesn't have an octothorpe prepended.

## Restrictions

This uses [edge-js](https://github.com/agracio/edge-js), so it only runs on windows, and from a node environment - it will not work in the browser.

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