imagemin

Minify images seamlessly

^{Sindre Sorhus' open source work is supported by the community}

^{Special thanks to:}

All your environment variables, in one place

Stop struggling with scattered API keys, hacking together home-brewed tools,
and avoiding access controls. Keep your team and servers in sync with Doppler.

Strapi is the leading open-source headless CMS.

^{It’s 100% JavaScript, fully customizable, and developer-first.}

Install

$ npm install imagemin

Usage

import imagemin from 'imagemin';
import imageminJpegtran from 'imagemin-jpegtran';
import imageminPngquant from 'imagemin-pngquant';

const files = await imagemin(['images/*.{jpg,png}'], {
    destination: 'build/images',
    plugins: [
        imageminJpegtran(),
        imageminPngquant({
            quality: [0.6, 0.8]
        })
    ]
});
console.log(files);
//=> [{data: , destinationPath: 'build/images/foo.jpg'}, …]

API

imagemin(input, options?)

Returns

Promise

{data: Buffer, sourcePath: string, destinationPath: string}

input

Type:

string[]

File paths or glob patterns.

options

Type:

object

destination

Type:

string

Set the destination folder to where your files will be written. If no destination is specified, no files will be written.

plugins

Type:

Array

Plugins to use.

glob

Type:

boolean

true

Enable globbing when matching file paths.

imagemin.buffer(buffer, options?)

Returns

Promise

buffer

Type:

Buffer

Buffer to optimize.

options

Type:

object

plugins

Type:

Array

Plugins to use.

Related

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