fast-average-color-node
TypeScript icon, indicating that this package has built-in type declarations

3.0.0 • Public • Published

Fast Average Color for Node.js

NPM version NPM Downloads install size

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

import { getAverageColor } from 'fast-average-color-node';

getAverageColor('./image.png').then(color => {
    console.log(color);
});

or

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

/**
 * @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.

/**
 * @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

MIT License

Links

Package Sidebar

Install

npm i fast-average-color-node

Weekly Downloads

3,617

Version

3.0.0

License

MIT

Unpacked Size

10.8 kB

Total Files

6

Last publish

Collaborators

  • hcodes