Skip to content
Minify PNG, JPEG, GIF and SVG images
JavaScript
Find file
Failed to load latest commit information.
.editorconfig tweaks Oct 30, 2015
.gitattributes init Dec 30, 2013
.gitignore init Dec 30, 2013
.travis.yml Travis CI: Test on Node.js v4.x.x and v5.x.x Dec 30, 2015
fixture.png init Dec 30, 2013
index.js use `plur` Jun 21, 2015
license tweaks Aug 14, 2014
package.json fix tests Oct 30, 2015
readme.md Close #159 PR: demonstrate svgo options need to be in their own liter… Feb 14, 2016
test.js tweaks Oct 30, 2015

readme.md

gulp-imagemin Build Status

Minify PNG, JPEG, GIF and SVG images with imagemin

Issues with the output should be reported on the imagemin issue tracker.

Install

$ npm install --save-dev gulp-imagemin

Usage

const gulp = require('gulp');
const imagemin = require('gulp-imagemin');
const pngquant = require('imagemin-pngquant'); // $ npm i -D imagemin-pngquant

gulp.task('default', () => {
    return gulp.src('src/images/*')
        .pipe(imagemin({
            progressive: true,
            svgoPlugins: [
                {removeViewBox: false},
                {cleanupIDs: false}
            ],
            use: [pngquant()]
        }))
        .pipe(gulp.dest('dist/images'));
});

API

Comes bundled with the following lossless optimizers:

imagemin([options])

Unsupported files are ignored.

options

Options are applied to the correct files.

optimizationLevel (png)

Type: number
Default: 3

Select an optimization level between 0 and 7.

The optimization level 0 enables a set of optimization operations that require minimal effort. There will be no changes to image attributes like bit depth or color type, and no recompression of existing IDAT datastreams. The optimization level 1 enables a single IDAT compression trial. The trial chosen is what. OptiPNG thinks it’s probably the most effective. The optimization levels 2 and higher enable multiple IDAT compression trials; the higher the level, the more trials.

Level and trials:

  1. 1 trial
  2. 8 trials
  3. 16 trials
  4. 24 trials
  5. 48 trials
  6. 120 trials
  7. 240 trials
progressive (jpg)

Type: boolean
Default: false

Lossless conversion to progressive.

interlaced (gif)

Type: boolean
Default: false

Interlace gif for progressive rendering.

multipass (svg)

Type: boolean
Default: false

Optimize svg multiple times until it's fully optimized.

svgoPlugins (svg)

Type: array
Default: []

Customize which SVGO plugins to use. More here.

use

Type: array
Default: null

Additional plugins to use with imagemin.

License

MIT © Sindre Sorhus

Something went wrong with that request. Please try again.