imagemin-overwrite

Minify images seamlessly and in-place

Usage no npm install needed!

<script type="module">
  import imageminOverwrite from 'https://cdn.skypack.dev/imagemin-overwrite';
</script>

README

imagemin-overwrite Build Status

Minify images seamlessly and in-place. Forked from imagemin/imagemin.

Install

$ npm install imagemin-overwrite

Usage

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

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

    console.log(files);
    //=> [{data: <Buffer 89 50 4e …>, sourcePath: 'images/foo.jpg', destinationPath: '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, the original files will be overwritten.

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.

Related