0.1.0 • Published 9 years ago
cronshot-imagemagick v0.1.0
cronshot-imagemagick
CronShot middleware to manipulate and save images with ImageMagick via gm
npm install cronshot-imagemagick
How
CronShot uses:
Setup
Install CronShot
npm install cronshot
Install ImageMagick
brew update && brew install imagemagick
Example
var cronshot = require('cronshot'),
middleware = {
'imagemagick': require('cronshot-imagemagick')
};
// Image Magick Example
// --------------------
// Takes a screenshot of sports.yahoo.com,
// and converts the screenshot to be a transparent image using Image Magick
// Image Magick example
cronshot.startCapturing({
// The webpage URL that you would like to take a screenshot of
'url': 'http://sports.yahoo.com',
// The local path where you would like to save the image
'path': __dirname,
// Only takes one screenshot
'cronPattern': false,
// What middleware functions to use each time a screenshot is taken
'saveMiddleware': [{
// Function that does all the Image Magick stuff
'middleware': middleware.imagemagick,
'options': {
'gmCommands': [{
'method': 'trim',
'args': []
}, {
'method': 'transparent',
'args': ['#FFFFFF']
}]
}
}]
}, function(err) {
// optional callback function once all screenshots have been taken
});
Options
Note: All methods supported by gm can be used
{
// The path where the screenshot will be saved
'path': '',
// The image name used to save the screenshot
'imageName': '',
// The ImageMagick methods that you would like to be used via the gm node module
'gmCommands': []
}
Contributing
Please send all PR's to the dev
branch.
If your PR is a code change:
- Install all node.js dev dependencies:
npm install
- Update the appropriate module inside of the
src/modules
directory. - Add a unit test inside of
tests/unit/cronshot-imagemagick.js
. - Verify that all tests are passing by running
npm test
. - Send the PR!
Credits
CronShot-ImageMagick would not have been possible without the help/inspiration of the following libraries/awesome people:
- GraphicsMagick for node
- Copyright (c) Aaron Heckmann, 2010 - MIT License
Contributors
0.1.0
9 years ago