imagemin
Minify images seamlessly
Gumlet is helping make open source sustainable by sponsoring Sindre Sorhus.
Optimised Image Delivery made simple
Install
$ npm install imagemin
Usage
const imagemin = ;const imageminJpegtran = ;const imageminPngquant = ; async { const files = await ; console; //=> [{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
- imagemin-cli - CLI for this module
- imagemin-app - GUI app for this module
- gulp-imagemin - Gulp plugin
- grunt-contrib-imagemin - Grunt plugin