Socket
Socket
Sign inDemoInstall

imagemin

Package Overview
Dependencies
305
Maintainers
3
Versions
48
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    imagemin

Minify images


Version published
Maintainers
3
Install size
25.6 MB
Created

Readme

Source

imagemin Build Status Build status

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

License

MIT © imagemin

Keywords

FAQs

Last updated on 17 Oct 2015

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc