Package Exports

fast-average-color-node

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (fast-average-color-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Fast Average Color for Node.js

A simple library that calculates the average color of any images for Node.js.

Install

npm i save fast-average-color-node

Using

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

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

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