Multer S3

This project is mostly an extension of multer-s3. As many images from an iPhone were rotating while uploading, we extended the code to solve this issue using sharp.

Installation

1npm install --save multer-s3-rotate

Usage

1var aws = require('aws-sdk')
2var express = require('express')
3var multer = require('multer')
4var multerS3 = require('multer-s3-rotate')
5
6var app = express()
7var s3 = new aws.S3({ /* ... */ })
8
9var upload = multer({
10  storage: multerS3({
11    s3: s3,
12    bucket: 'some-bucket',
13    metadata: function (req, file, cb) {
14      cb(null, {fieldName: file.fieldname});
15    },
16    key: function (req, file, cb) {
17      cb(null, Date.now().toString())
18    }
19  })
20})
21
22app.post('/upload', upload.array('photos', 3), function(req, res, next) {
23  res.send('Successfully uploaded ' + req.files.length + ' files!')
24})

Newly Added

To resize image, add resize and resizeOpts keys to the object

1var aws = require('aws-sdk')
2var express = require('express')
3var multer = require('multer')
4var multerS3 = require('multer-s3-rotate')
5
6var app = express()
7var s3 = new aws.S3({ /* ... */ })
8
9var upload = multer({
10  storage: multerS3({
11    s3: s3,
12    bucket: 'some-bucket',
13    resize: true, // default false
14    resizeOpts: { // Required if resize is true
15      width: 400,
16      height:400,
17      fit: 'inside'
18    },
19    metadata: function (req, file, cb) {
20      cb(null, {fieldName: file.fieldname});
21    },
22    key: function (req, file, cb) {
23      cb(null, Date.now().toString())
24    }
25  })
26})
27
28app.post('/upload', upload.array('photos', 3), function(req, res, next) {
29  res.send('Successfully uploaded ' + req.files.length + ' files!')
30})

Value for resize

• resize ( Boolean ) If true, resize action occurs else only images are rotated

Keys for resizeOpts

• width ( String || Number )
• height ( String || Number )
• fit ( String ) how the image should be resized to fit both provided dimensions, one of cover, contain, fill, inside or outside. (optional, default 'cover')
• position ( String ) position, gravity or strategy to use when fit is cover or contain. (optional, default 'centre')
• background ( String || Object ) background colour when using a fit of contain, parsed by the colormodule, defaults to black without transparency. (optional, default {r:0,g:0,b:0,alpha:1})
• kernel ( String ) the kernel to use for image reduction. (optional, default 'lanczos3')
• withoutEnlargement ( Boolean ) do not enlarge if the width or height are already less than the specified dimensions, equivalent to GraphicsMagick's > geometry option. (optional, default false)
• fastShrinkOnLoad ( Boolean ) take greater advantage of the JPEG and WebP shrink-on-load feature, which can lead to a slight moiré pattern on some images. (optional, default true)

Testing

The tests mock all access to S3 and can be run completely offline.

1npm test