images-folder-optimizer v0.0.37

images-folder-optimizer

A high performance package that uses sharp.js to recursively optimize, transform and convert images from a folder to smaller, web-friendly JPEG, PNG, WebP, GIF and AVIF images. It is also possible to add watermark to the output images controlling opacity and positioning.

FEATURES

• PROCCESS ALL IMAGE FILES IN A FOLDER AT ONCE
• SIGNIFICANT REDUCTION IN IMAGE SIZE
• SCAN FOR IMAGE FILES RECURSIVELY ON ALL SUBFOLDERS
• CONVERSION BETWEEN IMAGE FORMATS, CHOOSING BOTH INPUT AND OUTPUT FORMATS
• IMAGE RESIZING
• IMAGE TRANSFORMATIONS (ONLY BLUR FOR NOW)
• POSSIBILITY TO OVERLAP A WATERMARK IMAGE CONTROLLING ITS OPACITY
• FULL TYPESCRIPT SUPPORT
• FULL CONTROL FOR SHARP.JS PARAMETERS

HOW TO USE IN YOUR PROJECT

• INSTALL THE PACKAGE:

  npm install -D images-folder-optimizer

• CREATE A JAVASCRIPT (OR TYPESCRIPT) FILE, AS example.js:

  import { functionOptimizeImages } from 'images-folder-optimizer';
  
  functionOptimizeImages({
      stringOriginFolder: 'static/images/originals',
      stringDestinationFolder: 'static/images/optimized',
      arrayOriginFormats: ['jpg', 'png'],
      arrayDestinationFormats: ['webp', 'avif'],
  }).then((results) => {
      console.table(results);
  });

• RUN THE FILE:

  node example.js

• CHECK THE NEW IMAGES IN static/images/optimized.

BUILT-IN EXAMPLES

YOU CAN FIND BUILT-IN EXAMPLES IN src/examples/ [LINK]. LET'S TRY ONE OF THEM:

npx tsc
node dist/examples/exampleFormatConversion.js

PARAMETERS AND TYPING

• PARAMETERS FOR functionOptimizeImages:

• typeWatermarkOptions TYPE: