@types/gif.js v0.2.5

Installation

npm install --save @types/gif.js

Summary

This package contains type definitions for gif.js (https://github.com/jnordberg/gif.js#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gif.js.

index.d.ts

// Type definitions for gif.js 0.2
// Project: https://github.com/jnordberg/gif.js#readme
// Definitions by: Carlos Precioso <https://github.com/cprecioso>
//                 Marco Tulio <https://github.com/TulioAbreu>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

import { EventEmitter } from 'events';

export as namespace GIF;

declare namespace GIF {
    type DitherMethod =
        | 'FloydSteinberg'
        | 'FloydSteinberg-serpentine'
        | 'FalseFloydSteinberg'
        | 'FalseFloydSteinberg-serpentine'
        | 'Stucki'
        | 'Stucki-serpentine'
        | 'Atkinson'
        | 'Atkinson-serpentine';

    interface Options {
        repeat?: number | undefined;
        quality?: number | undefined;
        workers?: number | undefined;
        workerScript?: string | undefined;
        background?: string | undefined;
        width?: number | null | undefined;
        height?: number | null | undefined;
        transparent?: string | null | undefined;
        dither?: DitherMethod | boolean | undefined;
        debug?: boolean | undefined;
    }

    interface AddFrameOptions {
        delay?: number | undefined;
        copy?: boolean | undefined;
        dispose?: number | undefined;
    }
}

declare class GIF extends EventEmitter {
    readonly running: boolean;

    constructor(options?: GIF.Options);

    addFrame(
        image: CanvasImageSource | CanvasRenderingContext2D | WebGLRenderingContext | ImageData,
        options?: GIF.AddFrameOptions,
    ): void;

    setOption<K extends keyof GIF.Options>(key: K, value: GIF.Options[K]): void;
    setOptions(options: GIF.Options): void;

    on(event: 'abort' | 'start', listener: () => void): this;
    on(event: 'finished', listener: (blob: Blob, data: Uint8Array) => void): this;
    on(event: 'progress', listener: (percent: number) => void): this;

    once(event: 'abort' | 'start', listener: () => void): this;
    once(event: 'finished', listener: (blob: Blob, data: Uint8Array) => void): this;
    once(event: 'progress', listener: (percent: number) => void): this;

    render(): void;
    abort(): void;
}

export = GIF;

Additional Details

• Last updated: Thu, 08 Jul 2021 12:02:06 GMT
• Dependencies: none
• Global values: GIF

Credits

These definitions were written by Carlos Precioso, and Marco Tulio.