colourless v1.1.1

Colourless

This module limits colors in images. There are features to give maximum colors count or list of color codes.

Currently supports: .jpg ###LIVE DEMO 🌐 colourless-js.web.app

Installing

Just install using NPM

npm install --save colourless

Getting Started

Below there are examples how to use this module in different ways:

Example 1: Limit colors count

const Colourless = require('colourless');

const colourless = new Colourless('images/wolf.jpg');

const buffer = await colourless.limitColorsCount({
    allowedColorsCount: 5,
});

fs.writeFileSync('images/wolf-5-color.jpg', buffer);

Example 2: Choose allowed colors

let buffer;

// pass rgb array
 
buffer = await colourless.setColors({
    colors: [
              [0,0,0], // Black RGB
              [255,0,0], // Red RGB
              [255,255,255], // White RGB
            ]
});

// OR pass hex values

buffer = await colourless.setColors({
    colors: [
              ['#000000'], // Black HEX
              ['#ff0000'], // Red HEX
              ['#ffffff'], // White HEX
            ]
});

Example 3: Different input types

const Colourless = require('colourless');

let colourless;

// Image file path 
colourless= new Colourless('images/wolf.jpg');

// base64 input
colourless= new Colourless('data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEBLAE...');

// buffer as an imput
colourless= new Colourless(imageBuffer);

API

Colourless(path|base64|buffer)

• .limitColorsCount(options)

  • options.allowedColorsCount number of allowed colors (min: 2)

    returns buffer of modified image

• .setColors(options)

  • options.colors array of allowed colors in RGB or HEX formats (min: 2)

    returns buffer of modified image

License

This project is licensed under the MIT License - see the LICENSE file for details