1.0.4 • Published 3 years ago

express-image-render v1.0.4

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

This is an express middleware image render and processor, designed with image performance in mind, this module has proven powerful to deal with loads of images at high resolution to thumbnails in matter of milliseconds.

Installation

npm i -S express-image-render

Prior to install ensure you should have installed and configured sharp according to your system

On your express main file:

const imageRender = require("express-image-render");
//====================================================================
// ### ADD YOUR IMAGE RENDERING DIRECTORIES
//====================================================================
const imageOpts = {
  quality: 100, // 60 (default), added in v1.0.2 this allows image render quality output control min 1 max 100
};
app.use("/path/to/site/images", imageRender(imageOpts));
app.use("/path/to/another/folder/of/images", imageRender);

Usage

On your Front-end you can call your images adding the following image params:

    width: image output width in px
    height: image output in px
    format: will process the image to a specified format. jpeg, jpg, png, webp, gif, tiff, avif, heif, raw, tile, bmp
    crop: "cover" (default), contain, fill, inside, outside. Note: `cover and contain will center image`

Note: All GET requests to images and all operations will either read the default values or process the params if any present in the request.

Example:

<img
  src="/path/to/my/image/image.jpg?width=1000&height=800&format=webp&crop=cover"
/>