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 
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);
//=> [{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