imagemin

What is imagemin?

The imagemin npm package is a powerful tool for image compression and optimization. It allows developers to reduce the size of images without losing quality, which can significantly improve the performance of web applications by reducing load times.

What are imagemin's main functionalities?

Basic Image Compression

This code demonstrates how to use imagemin to compress JPEG and PNG images. The images are taken from the 'images' directory and the compressed versions are saved in the 'build/images' directory. The quality of JPEG images is set to 75, and the quality of PNG images is set between 60% and 80%.

const imagemin = require('imagemin');
const imageminMozjpeg = require('imagemin-mozjpeg');
const imageminPngquant = require('imagemin-pngquant');

(async () => {
    const files = await imagemin(['images/*.{jpg,png}'], {
        destination: 'build/images',
        plugins: [
            imageminMozjpeg({quality: 75}),
            imageminPngquant({quality: [0.6, 0.8]})
        ]
    });

    console.log(files);
})();

GIF Optimization

This code demonstrates how to optimize GIF images using imagemin. The GIF images are taken from the 'images' directory and the optimized versions are saved in the 'build/images' directory. The optimization level is set to 3, which is the highest level of optimization.

const imagemin = require('imagemin');
const imageminGifsicle = require('imagemin-gifsicle');

(async () => {
    const files = await imagemin(['images/*.gif'], {
        destination: 'build/images',
        plugins: [
            imageminGifsicle({optimizationLevel: 3})
        ]
    });

    console.log(files);
})();

SVG Optimization

This code demonstrates how to optimize SVG images using imagemin. The SVG images are taken from the 'images' directory and the optimized versions are saved in the 'build/images' directory. The SVGO plugin is configured to keep the viewBox attribute and not to remove IDs.

const imagemin = require('imagemin');
const imageminSvgo = require('imagemin-svgo');

(async () => {
    const files = await imagemin(['images/*.svg'], {
        destination: 'build/images',
        plugins: [
            imageminSvgo({
                plugins: [
                    {removeViewBox: false},
                    {cleanupIDs: false}
                ]
            })
        ]
    });

    console.log(files);
})();

Other packages similar to imagemin

sharp

Sharp is a high-performance image processing library that supports various image formats. It is known for its speed and efficiency, making it a popular choice for image resizing, cropping, and format conversion. Unlike imagemin, which focuses on compression and optimization, sharp provides a broader range of image manipulation functionalities.

jimp

Jimp is a pure JavaScript image processing library that does not require any external dependencies. It supports a wide range of image manipulation features, including resizing, cropping, and color adjustments. While imagemin is primarily used for image compression, Jimp offers a more comprehensive set of image editing tools.

image-webpack-loader

Image-webpack-loader is a loader for webpack that optimizes images during the build process. It uses imagemin under the hood but integrates seamlessly with webpack, making it a convenient choice for developers who are already using webpack for their build process. It provides similar functionalities to imagemin but is designed to work specifically within the webpack ecosystem.

README

imagemin

Minify images seamlessly

Install

$ npm install --save imagemin

Usage

var Imagemin = require('imagemin');

new Imagemin()
	.src('images/*.{gif,jpg,png,svg}')
	.dest('build/images')
	.use(Imagemin.jpegtran({progressive: true}))
	.run(function (err, files) {
		console.log(files[0]);
		// => {path: 'build/images/foo.jpg', contents: <Buffer 89 50 4e ...>}
	});

You can use gulp-rename to rename your files:

var Imagemin = require('imagemin');
var rename = require('gulp-rename');

new Imagemin()
	.src('images/foo.png')
	.use(rename('bar.png'));

API

new Imagemin()

Creates a new Imagemin instance.

.src(file)

Type: array, buffer or string

Set the files to be optimized. Takes a buffer, glob string or an array of glob strings as argument.

.dest(folder)

Type: string

Set the destination folder to where your files will be written. If you don't set any destination no files will be written.

.use(plugin)

Type: function

Add a plugin to the middleware stack.

.run(callback)

Type: function

Optimize your files with the given settings.

callback(err, files)

The callback will return an array of vinyl files in files.

Plugins

The following plugins are bundled with imagemin:

• gifsicle — Compress GIF images.
• jpegtran — Compress JPG images.
• optipng — Compress PNG images losslessly.
• svgo — Compress SVG images.

.gifsicle(options)

Compress GIF images.

var Imagemin = require('imagemin');

new Imagemin()
	.use(Imagemin.gifsicle({interlaced: true}));

.jpegtran(options)

Compress JPG images.

var Imagemin = require('imagemin');

new Imagemin()
	.use(Imagemin.jpegtran({progressive: true}));

.optipng(options)

Lossless compression of PNG images.

var Imagemin = require('imagemin');

new Imagemin()
	.use(Imagemin.optipng({optimizationLevel: 3}));

.svgo(options)

Compress SVG images.

var Imagemin = require('imagemin');

new Imagemin()
	.use(Imagemin.svgo());

CLI

$ npm install --global imagemin

$ imagemin --help

  Usage
    $ imagemin <file> <directory>
    $ imagemin <directory> <output>
    $ imagemin <file> > <output>
    $ cat <file> | imagemin > <output>

  Example
    $ imagemin images/* build
    $ imagemin images build
    $ imagemin foo.png > foo-optimized.png
    $ cat foo.png | imagemin > foo-optimized.png

  Options
    -i, --interlaced                    Interlace gif for progressive rendering
    -o, --optimizationLevel <number>    Optimization level between 0 and 7
    -p, --progressive                   Lossless conversion to progressive

Related

• imagemin-app
• gulp-imagemin
• grunt-contrib-imagemin

License

MIT © imagemin