1.0.2 • Published 2 years ago

imageminimize v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

imageminimize

Minify images seamlessly in easy way

NPM Version NPM Install Size NPM Downloads

Install

npm install imageminimize

Usage

import imageminimize from 'imageminimize';
import imageminJpegtran from 'imagemin-jpegtran';
import imageminPngquant from 'imagemin-pngquant';

const files = await imageminimize(['images/*.{jpg,png}'], {
	excludeFiles: ["logo192.png", "logo512.png", "thumbnail.jpg"],
	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

imageminimize(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.

imageminimize.buffer(buffer, options?)

Returns Promise<Buffer>.

buffer

Type: Buffer

Buffer to optimize.

options

Type: object

plugins

Type: Array

Plugins to use.

Support

This package costs me time to make and maintain every time.

I am very 😀 about every coffee!