rdjpalmer / imagemin

Tense, nervous, minifying images?

imagemin

Minify images seamlessly

Install

$ npm install --save imagemin

Usage

const Imagemin = require('imagemin');

new Imagemin()
	.src('images/*.{gif,jpg,png,svg}')
	.dest('build/images')
	.use(Imagemin.jpegtran({progressive: true}))
	.run((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:

const Imagemin = require('imagemin');
const 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.

const Imagemin = require('imagemin');

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

.jpegtran(options)

Compress JPG images.

const Imagemin = require('imagemin');

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

.optipng(options)

Lossless compression of PNG images.

const Imagemin = require('imagemin');

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

.svgo(options)

Compress SVG images.

const Imagemin = require('imagemin');

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

Related

• imagemin-cli - CLI for this module
• imagemin-app - GUI app for this module.
• gulp-imagemin - Gulp plugin.
• grunt-contrib-imagemin - Grunt plugin.

License

MIT © imagemin