Package Exports

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 (@jimp/plugin-threshold) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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