render-gif v2.0.4

render-gif

Render a gif and provide frames to draw.

Install

npm install render-gif

Usage

const fs = require("fs");
const logUpdate = require("log-update");
const renderGif = require("render-gif");
 
renderGif(fs.readFileSync("unicorn.gif"), logUpdate);

API

renderGif(data, callback, options?)

data

Type: array-like

The gif data. Can be anything array-like such as a Buffer, Array or Uint8Array.

callback

Type: (data: ArrayLike) => void

The callback to provide each rendered frame to.

options

Type: object

maximumFrameRate

Type: number\ Default: Infinity

The maximum framerate to render the gif at.

Return value

isPlaying

Type: boolean\ Default: true

Whether the animation should be rendered and provided to the callback.