2.1.0 • Published 4 years ago
crop-node v2.1.0
crop-node
Crop all transparent pixel around an image's edges. (CLI version)
Installation
npm install crop-node
Usage
const crop = require("crop-node");
const { writeFileSync } = require("fs");
// Path to an image file
const path = "path/to/image.png";
const options = {
outputFormat: "png",
};
// Run the async function and write the result
(async () => {
const cropped = await crop(path, options);
// Write the file (for example)
writeFileSync("cropped.png", cropped);
})();
Documentation
crop(input, [options])
Name | Type | Default | Comment |
---|---|---|---|
input | String|HTMLCanvasElement | required | Path to the image to process or a tainted canvas |
options | Options | (see below) | Some options |
options
Name | Type | Default | Comment |
---|---|---|---|
outputFormat | String | "png" | Format of the output image ("png" or "jpeg" ) |
In addition, all options of detect-edges
are supported.
Related
- CLI version
crop-node-cli
- Browser version
crop-browser
- Environment agnostic
crop-universal