imagemin

by imagemin

imagemin / imagemin

Minify images seamlessly

4.3K Stars 233 Forks Last release: 11 months ago (v7.0.1) MIT License 269 Commits 54 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

imagemin Build Status

Minify images seamlessly

Install

$ npm install imagemin

Usage

const imagemin = require('imagemin');
const imageminJpegtran = require('imagemin-jpegtran');
const imageminPngquant = require('imagemin-pngquant');

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

console.log(files);
//=&gt; [{data: <buffer>, destinationPath: 'build/images/foo.jpg'}, …]

})();

API

imagemin(input, options?)

Returns

Promise
in the format
{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
\ Default:
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.

Hosted API

We also provide a hosted API for imagemin which may simplify your use case.

Related

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.