Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/imagemin/imagemin-zopfli

zopfli plugin for imagemin
https://github.com/imagemin/imagemin-zopfli

Last synced: 3 days ago
JSON representation

zopfli plugin for imagemin

Awesome Lists containing this project

README

        

# imagemin-zopfli ![GitHub Actions Status](https://github.com/imagemin/imagemin-zopfli/workflows/test/badge.svg?branch=master)

> [Zopfli](https://en.wikipedia.org/wiki/Zopfli) imagemin plugin

## Install

```
$ npm install --save imagemin-zopfli
```

## Usage

```js
const imagemin = require('imagemin');
const imageminZopfli = require('imagemin-zopfli');

imagemin(['images/*.png'], 'build/images', {
use: [
imageminZopfli({more: true})
]
}).then(() => {
console.log('Images optimized');
});
```

## API

### imageminZopfli([options])(buffer)

#### options

Type: `Object`

##### 8bit

Type: `boolean`

Default: `false`

Convert 16-bit per channel image to 8-bit per channel.

##### transparent

Type: `boolean`

Default: `false`

Allow altering hidden colors of fully transparent pixels.

##### iterations

Type: `integer`

Default: `15`

Number of iterations for images smaller than 200 KiB.

##### more

Type: `boolean`

Default: `false`

Compress more using more iterations (depending on file size).

#### buffer

Type: `Buffer`

Buffer to optimize.

## License

MIT © [imagemin](https://github.com/imagemin)