Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Node.js module for image processing and manipulation.

tree: 2a73aed5a9

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 .gitignore
Octocat-spinner-32 CHANGELOG.md
Octocat-spinner-32 README.md
Octocat-spinner-32 easyimage.js
Octocat-spinner-32 package.json
Octocat-spinner-32 test.js
README.md

EasyImage

EasyImage is built on top of ImageMagick, so make sure ImageMagick is installed on your system.

On Ubuntu

$ apt-get install imagemagick

On Mac OS X

$ brew install imagemagick

On CentOS

$ yum install imagemagick

Installation

$ npm install easyimage

Usage

var easyimg = require('easyimage');

EasyImage offers these methods:

easyimg.info(<image_path>, <callback_function>) - to retrieve information about an image (name, type, width, height, size, depth)
easyimg.convert(<options>, <callback_function>) - to convert an image from one format to another
easyimg.resize(<options>, <callback_function>) - to resize an image
easyimg.crop(<options>, <callback_function>) - to crop an image
easyimg.thumbnail(<options>, <callback_function>) - to create square thumbnails
easyimg.rescrop(<options>, <callback_function>) - to resize and crop and image in one go, useful for creating customzied thumbnails
easyimg.exec(<command>, <callback_function>) - when you want to call a custom command to ImageMagick, you will need to take care of escaping special characters etc

The EasyImage options object can have these properties depending on the method. Unrelated options are ignored.

src - path to source image
dst - path to destination image
width - width of resized image
height - height of resized image
cropwidth - width of cropped image, if missing, width will be used instead
cropheight - height of cropped image, if missing, height will be used instead
x - x offset for cropping, defaults to 0
y - y offset for cropping, defaults to 0
quality - quality of processed image, 1 to 100
gravity - crop position [NorthWest | North | NorthEast | West | Center | East | SouthWest | South | SouthEast], defaults to Center
fill - fill area flag, image is resized to completely fill the target crop dimensions, defaults to false

Examples

Example 1

easyimg.info('kitten.jpg', function(err, stdout, stderr) {
  if (err) throw err;
  console.log(stdout);
});

Example 2

easyimg.rescrop(
  {
     src:'kitten.jpg', dst:'kitten-thumbnail.jpg',
     width:500, height:500,
     cropwidth:128, cropheight:128,
     x:0, y:0
     },
  function(err, image) {
     if (err) throw err;
     console.log('Resized and cropped: ' + image.width + ' x ' + image.height);
  }
);

For more examples check out test.js.

License (MIT)

Copyright (c) 2012 Hack Sparrow <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.

Something went wrong with that request. Please try again.