https://github.com/fast-average-color/fast-average-color-node
🍏🍊🍅 A simple library that calculates the average color of any images for Node.js
https://github.com/fast-average-color/fast-average-color-node
average-color color nodejs
Last synced: about 1 year ago
JSON representation
🍏🍊🍅 A simple library that calculates the average color of any images for Node.js
- Host: GitHub
- URL: https://github.com/fast-average-color/fast-average-color-node
- Owner: fast-average-color
- License: mit
- Created: 2020-10-21T10:07:46.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-20T07:43:18.000Z (over 1 year ago)
- Last Synced: 2025-03-31T16:17:22.866Z (over 1 year ago)
- Topics: average-color, color, nodejs
- Language: TypeScript
- Homepage:
- Size: 632 KB
- Stars: 86
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🍏🍊🍅 [Fast Average Color](https://github.com/fast-average-color/fast-average-color/) for Node.js
[](https://www.npmjs.com/package/fast-average-color-node)
[](https://www.npmjs.org/package/fast-average-color-node)
[](https://packagephobia.com/result?p=fast-average-color-node)
A simple library that calculates the average color of any images for Node.js.
## Supported formats:
- `jpeg`
- `png`
- `webp`
- `gif`
- `svg`
## Source
- filename
- url
- Buffer
- base64 string
## Install
`npm i --save fast-average-color-node`
## Using
```js
import { getAverageColor } from 'fast-average-color-node';
getAverageColor('./image.png').then(color => {
console.log(color);
});
```
or
```js
import { getAverageColor } from 'fast-average-color-node';
async function printAverageColor() {
const color = await getAverageColor('./image.png');
console.log(color);
};
printAverageColor();
```
## API
### `getAverageColor(filename, options)`
#### Parameters
```js
/**
* @param {string | Buffer} [filename] filename, url, Buffer or data64 string
* @param {Object} [options]
* @param {number[]} [options.defaultColor=[0, 0, 0, 0]]
* @param {number[]} [options.ignoredColor] [red (0-255), green (0-255), blue (0-255), alpha (0-255)]
* @param {string} [options.mode="speed"] "precision" or "speed"
* @param {string} [options.algorithm="sqrt"] "simple", "sqrt" or "dominant"
* @param {number} [options.step=1]
* @param {number} [options.left=0]
* @param {number} [options.top=0]
* @param {number} [options.width=width of resource]
* @param {number} [options.height=height of resource]
* @param {boolean} [options.silent] Disable error output via console.error
*/
```
### Return value
The promise with value.
```js
/**
* @param {Object} [color]
* @param {string} [color.rgb]
* @param {string} [color.rgba]
* @param {string} [color.hex]
* @param {string} [color.hexa]
* @param {boolean} [color.isDark]
* @param {boolean} [color.isLight]
* @param {number[]} [color.value]
* @param {Error} [color.error]
*/
```
## [License](LICENSE)
MIT License
## Links
- [fast-average-color](https://github.com/fast-average-color/fast-average-color/)
## Friends
- [Check device online](https://checkdevice.online/?from=github-fac-node)