JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1139946
  • Score
    100M100P100Q172291F
  • License MIT

Minify images

Package Exports

  • imagemin
  • imagemin/package
  • imagemin/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (imagemin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

imagemin Build Status Build status

Minify images seamlessly with Node.js

Install

$ npm install --save imagemin

Usage

var Imagemin = require('imagemin');

var imagemin = new Imagemin()
    .src('images/*.{gif,jpg,png,svg}')
    .dest('build/images')
    .use(Imagemin.jpegtran({ progressive: true }));

imagemin.run(function (err, files) {
    if (err) {
        throw err;
    }
    
    console.log(files[0]);
    // => { contents: <Buffer 89 50 4e ...> }
});

API

new Imagemin()

Creates a new Imagemin instance.

.src(file)

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

.dest(folder)

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

.use(plugin)

Add a plugin to the middleware stack.

.run(cb)

Optimize your files with the given settings.

Plugins

The following plugins are bundled with imagemin:

  • gifsicle — Compress GIF images.
  • jpegtran — Compress JPG images.
  • optipng — Lossless compression of PNG images.
  • pngquant — Lossy compression of PNG images.
  • svgo — Compress SVG images.

.gifsicle()

Compress GIF images.

var Imagemin = require('imagemin');

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

.jpegtran()

Compress JPG images.

var Imagemin = require('imagemin');

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

.optipng()

Lossless compression of PNG images.

var Imagemin = require('imagemin');

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

.pngquant()

Lossy compression of PNG images.

var Imagemin = require('imagemin');

var imagemin = new Imagemin()
    .use(Imagemin.pngquant());

.svgo()

Compress SVG images.

var Imagemin = require('imagemin');

var imagemin = new Imagemin()
    .use(Imagemin.svgo());

CLI

$ npm install --global imagemin
$ imagemin --help

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

Example
  $ 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>    Select an optimization level between 0 and 7
  -p, --progressive                   Lossless conversion to progressive

License

MIT © imagemin