EasyImage is a promise-based image processing module for Node.js, it is built on top of ImageMagick, so make sure ImageMagick is installed on your system.
EasyImage 3 is only compatible with NodeJS 4 or greater.
$ npm install --save easyimage
For NodeJS 0.12, use EasyImage 2
$ npm install --save easyimage@2
Get info about an image.
import {info} from "easyimage";
try {
const imageInfo = await info("/path/to/image.jpg");
} catch (e) {
console.log("Error: ", e);
}
Convert an image from JPG to PNG.
import {convert} from "easyimage";
try {
await convert({
src: "/path/to/source.jpg",
dst: "/path/to/dest.png",
});
} catch (e) {
console.log("Error: ", e);
}
Create a thumbnail.
import {thumbnail} from "easyimage";
try {
const thumbnailInfo = await thumbnail({
src: "/path/to/source.jpg",
width: 100,
height: 100,
});
console.log("Thumbnail is at: " + thumbnailInfo.path);
} catch (e) {
console.log("Error: ", e);
}
The EasyImage module is ES6 compatible. You can import just the commands that you will need.
Every command which takes an options object which extends from IBaseOptions. You can use
any of the parameters defined on IBaseOptions. For example, to prevent EasyImage from auto-orientating your image, you can pass autoOrient: false on any
command.
Every command must have a src parameter. If you do not specify a dst, then a random file will be created. Be sure to clean up randomly created files by
either moving them to permanent storage, or deleting them. Some commands have other required options.
See the Docs for all available options for each command.
convert
The convert() command can convert an image file from one type to another.
crop
The crop() command will crop an image to the specified size.
resize
The resize() command will resize an image to the specified size.
rescrop
The rescrop() command will resize and crop an image to the specified size.
rotate
The rotate() command will rotate an image by the specified number of degrees.
thumbnail
The thumbnail() command will create a thumbnail of the specified image.
In addition to the above commands, there are three other commands available.
info
The info() command will give you details about an image file.
execute
The execute() command allows you directly run ImageMagick with your own tool and arguments. It will handle calling the appropriate ImageMagick version, and
return the raw stdout and stderr to you.
getImageMagickVersion
The getImageMagickVersion() command will return the detected version of ImageMagick.
There are 5 different types of errors that can be thrown.
BadDestinationErrorImageMagickMissingErrorMissingExtensionErrorMissingOptionsErrorUnsupportedError
Which allows you to catch specific errors.
import {convert, MissingOptionsError} from "easyimage";
async function shouldError() {
try {
await convert({});
console.log("I should not show");
} catch (MissingOptionsError e) {
console.log("I should show");
} catch (Error e) {
console.log("I should not show either");
}
}
Copyright (c) 2015 Hage Yaapa <http://www.hacksparrow.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.