shichen b6c5ecc67a init 10 mesi fa
..
dist b6c5ecc67a init 10 mesi fa
es b6c5ecc67a init 10 mesi fa
node_modules b6c5ecc67a init 10 mesi fa
src b6c5ecc67a init 10 mesi fa
test b6c5ecc67a init 10 mesi fa
CHANGELOG.md b6c5ecc67a init 10 mesi fa
LICENSE b6c5ecc67a init 10 mesi fa
README.md b6c5ecc67a init 10 mesi fa
babel.config.js b6c5ecc67a init 10 mesi fa
index.d.ts b6c5ecc67a init 10 mesi fa
package.json b6c5ecc67a init 10 mesi fa

README.md

@jimp/plugin-threshold

Lightens an image.

This is useful as a simplified method for processing scanned drawings, signatures, etc

Usage

  • @param {number} options object
    • max: A number auto limited between 0 - 255
    • replace: (optional) A number auto limited between 0 - 255 (default 255)
    • autoGreyscale: (optional) A boolean whether to apply greyscale beforehand (default true)
  • @param {function(Error, Jimp)} cb (optional) a callback for when complete
import jimp from 'jimp';

async function main() {
  const image = await jimp.read('test/image.png');

  image.threshold({ max: 150 });
  // or
  image.threshold({ max: 200, replace: 200, autoGreyscale: false });
}

main();