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

Imagemin plugin for Gifsicle
https://github.com/imagemin/imagemin-gifsicle

gif gifsicle imagemin imagemin-plugin nodejs npm-package

Last synced: 5 days ago
JSON representation

Imagemin plugin for Gifsicle

• Host: GitHub
• URL: https://github.com/imagemin/imagemin-gifsicle
• Owner: imagemin
• License: mit
• Created: 2014-04-23T12:02:47.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2023-10-09T14:31:23.000Z (about 1 year ago)
• Last Synced: 2024-11-24T01:14:33.384Z (19 days ago)
• Topics: gif, gifsicle, imagemin, imagemin-plugin, nodejs, npm-package
• Language: JavaScript
• Homepage:
• Size: 47.9 KB
• Stars: 117
• Watchers: 10
• Forks: 55
• Open Issues: 17
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

• awesome-github-star - imagemin-gifsicle

README

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

> Imagemin plugin for [Gifsicle](https://www.lcdf.org/gifsicle/)

## Install

```

$ npm install imagemin-gifsicle

```

## Usage

```js

import imagemin from 'imagemin';

import imageminGifsicle from 'imagemin-gifsicle';

(async () => {

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

		destination: 'build/images',

		plugins: [

			imageminGifsicle()

		]

	});

	console.log('Images optimized');

})();

```

## API

### imageminGifsicle(options?)(buffer)

Returns a `Promise` with the optimized image.

#### options

Type: `object`

##### interlaced

Type: `boolean`\

Default: `false`

Interlace gif for progressive rendering.

##### optimizationLevel

Type: `number`\

Default: `1`

Select an optimization level between `1` and `3`.

> The optimization level determines how much optimization is done; higher levels take longer, but may have better results.

1. Stores only the changed portion of each image.

2. Also uses transparency to shrink the file further.

3. Try several optimization methods (usually slower, sometimes better results)

##### colors

Type: `number`

Reduce the number of distinct colors in each output GIF to num or less. Num must be between 2 and 256.

#### buffer

Type: `Buffer`

Buffer to optimize.