npm.devtool.tech
👏 You can access imagemin package with using imagemin variable in browser devtools!
Minify images seamlessly

code/package/bundle size

0B
publish
0B
install
0B
bundle minified
0B
bundle gzipped

imagemin GitHub Actions Status

Minify images seamlessly



Sindre Sorhus' open source work is supported by the community

Special thanks to:



Doppler
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.



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: <Buffer 89 50 4e …>, destinationPath: 'build/images/foo.jpg'}, …]

API

imagemin(input, options?)

Returns Promise<object[]> 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>.

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

🔎Explore Package🔎CDN Script

Score

Popularity55/100
Quality83/100
Maintenance65/100