# gifencoder > Streaming server-side animated (and non-animated) gif generation for node.js Latest version **2.0.1** (published 2018-12-18) · BSD-3-Clause license · 0 weekly downloads ## Install ```sh npm install gifencoder pnpm add gifencoder yarn add gifencoder bun add gifencoder ``` ## Health **Score 23/100 (F)** — status: abandoned. Positive: has types package; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.0.1 | | Published | 2018-12-18 | | First published | 2013-10-04 | | Weekly downloads | 0 | | License | BSD-3-Clause | | TypeScript types | separate (@types/gifencoder) | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 134.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 476 | | Author | Eugene Ware | | Maintainers | eugeneware, heikkipora, raine, rochoa | | Keywords | gif, encode, encoder, GIF, encoding, animated, canvas, node-canvas, server, image, images, animations | ## Links - npm: https://www.npmjs.com/package/gifencoder - Repository: https://github.com/eugeneware/gifencoder - Homepage: https://github.com/eugeneware/gifencoder#readme - Issues: https://github.com/eugeneware/gifencoder/issues - npm.io page: https://npm.io/package/gifencoder ## Dependencies (1) - [canvas](https://npm.io/package/canvas.md) ^2.2.0 ## Alternatives - [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads - [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads - [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads - [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads - [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads ## Recent versions - 2.0.1 (latest) — 2018-12-18 - 2.0.0 — 2018-12-18 - 1.1.0 — 2017-07-14 - 1.0.6 — 2015-01-05 - 1.0.5 — 2014-10-22 - 1.0.3 — 2013-10-05 - 1.0.2 — 2013-10-05 - 1.0.1 — 2013-10-05 - 1.0.0 — 2013-10-05 - 0.2.0 — 2013-10-05 - 0.1.0 — 2013-10-04 - 0.0.1 — 2013-10-04 ## README # gifencoder Streaming server-side animated (and non-animated) gif generation for node.js [![build status](https://secure.travis-ci.org/eugeneware/gifencoder.png)](http://travis-ci.org/eugeneware/gifencoder) ## Installation This module is installed via npm: ``` bash $ npm install gifencoder ``` ## Streaming API - Duplex Piping with Writes You can also stream writes of pixel data (or canvas contexts) to the encoder: ``` js const GIFEncoder = require('gifencoder'); const encoder = new GIFEncoder(854, 480); const pngFileStream = require('png-file-stream'); const fs = require('fs'); const stream = pngFileStream('test/**/frame?.png') .pipe(encoder.createWriteStream({ repeat: -1, delay: 500, quality: 10 })) .pipe(fs.createWriteStream('myanimated.gif')); stream.on('finish', function () { // Process generated GIF }); // Alternately, you can wrap the "finish" event in a Promise await new Promise((resolve, reject) => { stream.on('finish', resolve); stream.on('error', reject); }); ``` NB: The chunks that get emitted by your read stream must either by a 1-dimensional bitmap of RGBA data (either an array or Buffer), or a canvas 2D `context`. ## Example: Streaming API - Reads You can also use a streaming API to receive data: ``` js const GIFEncoder = require('gifencoder'); const { createCanvas } = require('canvas'); const fs = require('fs'); const encoder = new GIFEncoder(320, 240); // stream the results as they are available into myanimated.gif encoder.createReadStream().pipe(fs.createWriteStream('myanimated.gif')); encoder.start(); encoder.setRepeat(0); // 0 for repeat, -1 for no-repeat encoder.setDelay(500); // frame delay in ms encoder.setQuality(10); // image quality. 10 is default. // use node-canvas const canvas = createCanvas(320, 240); const ctx = canvas.getContext('2d'); // red rectangle ctx.fillStyle = '#ff0000'; ctx.fillRect(0, 0, 320, 240); encoder.addFrame(ctx); // green rectangle ctx.fillStyle = '#00ff00'; ctx.fillRect(0, 0, 320, 240); encoder.addFrame(ctx); // blue rectangle ctx.fillStyle = '#0000ff'; ctx.fillRect(0, 0, 320, 240); encoder.addFrame(ctx); encoder.finish(); ``` The above code will generate the following animated GIF: ![Animated GIF](https://raw.github.com/eugeneware/gifencoder/master/examples/myanimated.gif) ## Contributing gifencoder is an **OPEN Open Source Project**. This means that: > Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project. See the [CONTRIBUTING.md](https://github.com/eugeneware/gifencoder/blob/master/CONTRIBUTING.md) file for more details. ### Contributors gifencoder is only possible due to the excellent work of the following contributors:
Kevin Weinerkweiner@fmsware.com
Thibault Imberthttp://www.bytearray.org/
Eugene WareGitHub/eugeneware
Raine VirtaGitHub/raine
Paul OchoaGitHub/rochoa
Heikki PoraGitHub/heikkipora
--- _Source: https://npm.io/package/gifencoder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._