History

Lee2vv 0b82373111 init		2024-05-05 13:46:50 +08:00
..
dist	init	2024-05-05 13:46:50 +08:00
src	init	2024-05-05 13:46:50 +08:00
test	init	2024-05-05 13:46:50 +08:00
CHANGELOG.md	Backup	2023-08-18 21:52:54 +08:00
LICENSE	Backup	2023-08-18 21:52:54 +08:00
README.md	Backup	2023-08-18 21:52:54 +08:00
babel.config.js	init	2024-05-05 13:46:50 +08:00
index.d.ts	Backup	2023-08-18 21:52:54 +08:00
package.json	Backup	2023-08-18 21:52:54 +08:00

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