Name Last Update
..
dist Loading commit data...
es Loading commit data...
src Loading commit data...
test Loading commit data...
CHANGELOG.md Loading commit data...
LICENSE Loading commit data...
README.md Loading commit data...
babel.config.js Loading commit data...
index.d.ts Loading commit data...
package.json Loading commit data...

@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();