willyb-sharper v1.0.3

sharper

Automatic image processor built on top of sharp and multer for express.

How does it work?

When you are working on a website which needs to create multiple size copies of a single image uploaded by user, resize | crop | process and finally upload in a dynamic directory based on current date or time, then this module will save your entire lifetime.

Basically, this module provide an express middleware that do all above things at once. If something goes wrong, you can catch it in error middleware. You need to provide few options that will tell sharper about location of upload, dynamic date format for upload folder to be created, accepted image types, upload size limits, output format, and output sizes with prefixes etc.

This module is based on sharp node-js module for image processing. It's the fastest module there is and based on libvips library.

Install

npm install --save sharper

Configure

set options

const sharper = require('sharper');
var Sharper = sharper({
    field : 'file',
    location : '/var/www/uploads/',
    dirFormat : 'yyyy/mmm/d',
    maxFileSize: '20mb',
    fileNameLen : 50,
    accept : ['jpeg', 'jpg', 'png'],
    output : 'jpg',
    sizes : [
        {suffix : 'xlg', width : 1200, height : 1200},
        {suffix : 'lg', width : 800, height : 800},
        {suffix : 'md', width : 500, height : 500},
        {suffix : 'sm', width : 300, height : 300},
        {suffix : 'xs', width : 100, height : 100},
    ]
});

add middleware

app.post('/upload', Sharper, function(err, req, res, next){
    console.log(err);
    res.status(500).send('upload failed...');
}, function(req, res){
    console.log(res.sharper);
    res.send('upload successful...');
});

Options

var Sharper = sharper(options);

sharper options

sharp options

Please visit this sharp sharp for detailed overview of specific option.

Errors

You can catch errors in error middleware as shown previously. err object includes (but not limited to) following error codes (key code).

Success

Upon successful upload, sharper will add sharper object in res response object. It will have following properties.

Test

• npm install
• npm install -g mocha
• npm test

in practice

• npm install -g bower
• bower install
• Open terminal and run node test-server.js in demo folder of this module.
• Open your browser and go to http://localhost:8800.
• Upload a photo by clicking on dropzone.
• If upload sucessfully completes, check upload directory /var/www/html.
• If error occurs, check your terminal.

If you are facing node-gyp related error, go to node_modules/sharper/node_modules/sharp and use cmd command node-gyp rebuild. Make sure you have node-gyp installed or use npm install -g node-gyp