Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 3.05 KB

README.md

File metadata and controls

70 lines (47 loc) · 3.05 KB
Raw

Sharp-Multer

Small Utilty to use with Multer as storage engine to optimise images on the fly It uses Sharp to optimise images to jpg, png, webp as well as resize them.

Install

npm install sharp-multer

Example

    const multer = require("multer");

    const SharpMulter = require("sharp-multer");
    const  app  =  express();

    const  storage  =  SharpMulter({
    destination:  (req,  file,  callback)  =>  callback(null,  "images"),

    imageOptions:  {
        fileFormat:  "png",
        quality:  80,
        resize:  { width:  500, height:  500, resizeMode:  "contain"  },
        },

    watermarkOptions:  {
        input:  "./images/logo.png",
        location:  "top-right",
        },
    });
    const  upload  =  multer({ storage })
    app.post("/upload", upload.single("avatar"),  async  (req,  res)  =>  {

    console.log(req.file);

    return res.json("File Uploaded Successfully!");

    });

Image Options

Key Option Description
fileFormat jpg / png/ webp 'Default:"jpg" Output file type
resize {height:"", widht:"",resizeMode:"" } 'Default:{}' If provided Images will be resized before saving
quality Number(0-100) 'Default :80' Reduces the qulity for better performance
useTimestamp true/false 'Default :false'(optional) Adds suffice to file name Ex: "Images_1653679779.jpg"
watermarkOptions {input:"", location:"",opacity:1-100} (optional) Adds watermark on every Images before Saving

resizeMode

resize.resizeMode

  • cover: (default) Preserving aspect ratio, ensure the image covers both provided dimensions by cropping/clipping to fit.
  • contain: Preserving aspect ratio, contain within both provided dimensions using "letterboxing" where necessary.
  • fill: Ignore the aspect ratio of the input and stretch to both provided dimensions. i.e images will be strached to match size provided
  • inside: Preserving aspect ratio, resize the image to be as large as possible while ensuring its dimensions are less than or equal to both those specified. i.e width will be fixed to max value you provide and height will be adjusted to a lower value than provided according to Aspect Ratio .
  • outside: Preserving aspect ratio, resize the image to be as small as possible while ensuring its dimensions are greater than or equal to both those specified. i.e height will be fixed to value you provide and width will be adjusted to a higher value than provided according to Aspect Ratio

location

watermarkOptions.location

watermarkOptions supports total 5 locations : "center","top-left","top-right","bottom-left","bottom-right"

Feel free to open a Issue for features or bug fixes

Thanks