website/node_modules/imagemin/readme.md

In JohnCoene/chirp: 'Twitter' Networks Analyser

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}'], 'build/images', {
        plugins: [
            imageminJpegtran(),
            imageminPngquant({quality: '65-80'})
        ]
    });

    console.log(files);
    //=> [{data: <Buffer 89 50 4e …>, path: 'build/images/foo.jpg'}, …]
})();

API

imagemin(input, [output], [options])

Returns Promise<Object[]> in the format {data: Buffer, path: string}.

input

Type: string[]

Files to be optimized. See supported minimatch patterns.

output

Type: string

Set the destination folder to where your files will be written. If no destination is specified no files will be written.

options

Type: Object

plugins

Type: Array

Plugins to use.

imagemin.buffer(buffer, [options])

Returns Promise<Buffer>.

buffer

Type: Buffer

Buffer to optimize.

options

Type: Object

plugins

Type: Array

Plugins to use.

Related

• imagemin-cli - CLI for this module
• imagemin-app - GUI app for this module
• gulp-imagemin - Gulp plugin
• grunt-contrib-imagemin - Grunt plugin

License

MIT © imagemin

JohnCoene/chirp documentation built on May 25, 2021, 6:33 p.m.