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

Imagemin plugin for `pngquant`
https://github.com/imagemin/imagemin-pngquant

Last synced: 3 days ago
JSON representation

Imagemin plugin for `pngquant`

• Host: GitHub
• URL: https://github.com/imagemin/imagemin-pngquant
• Owner: imagemin
• License: mit
• Created: 2014-04-23T12:20:54.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2024-07-29T19:47:21.000Z (4 months ago)
• Last Synced: 2024-11-01T16:03:39.538Z (11 days ago)
• Language: JavaScript
• Homepage:
• Size: 343 KB
• Stars: 316
• Watchers: 10
• Forks: 81
• Open Issues: 15
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# imagemin-pngquant

> [Imagemin](https://github.com/imagemin/imagemin) plugin for [`pngquant`](https://github.com/kornelski/pngquant)

## Install

```sh

npm install imagemin-pngquant

```

### Prerequisites

> **Linux** machines must have the following packages prior to install: `libpng-dev libimagequant-dev`  

```sh

sudo apt-get -y install libpng-dev libimagequant-dev

```

## Usage

```js

import imagemin from 'imagemin';

import imageminPngquant from 'imagemin-pngquant';

await imagemin(['images/*.png'], {

	destination: 'build/images',

	plugins: [

		imageminPngquant()

	]

});

console.log('Images optimized');

```

## API

### imageminPngquant(options?)(input)

Returns `Promise`.

#### options

Type: `object`

##### speed

Type: `number`\

Default: `4`\

Values: `1` (brute-force) to `11` (fastest)

Speed `10` has 5% lower quality, but is about 8 times faster than the default. Speed `11` disables dithering and lowers compression level.

##### strip

Type: `boolean`\

Default: `false`

Remove optional metadata.

##### quality

Type: `Array`\

Values: `Array<0...1, 0...1>`\

Example: `[0.3, 0.5]`

Instructs pngquant to use the least amount of colors required to meet or exceed

the max quality. If conversion results in quality below the min quality the

image won't be saved.

Min and max are numbers in range 0 (worst) to 1 (perfect), similar to JPEG.

##### dithering

Type: `number | boolean`\

Default: `1` (full)\

Values: `0...1`

Set the dithering level using a fractional number between 0 (none) and 1 (full).

Pass in `false` to disable dithering.

##### posterize

Type: `number`

Truncate number of least significant bits of color (per channel). Use this when image will be output on low-depth displays (e.g. 16-bit RGB). pngquant will make almost-opaque pixels fully opaque and will reduce amount of semi-transparent colors.

#### input

Type: `Uint8Array`

Image data to optimize.