# @types/gifencoder

> TypeScript definitions for gifencoder

Latest version **2.0.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/gifencoder
pnpm add @types/gifencoder
yarn add @types/gifencoder
bun add @types/gifencoder
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.3 |
| Published | 2023-11-07 |
| First published | 2020-09-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51444 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/gifencoder
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gifencoder
- npm.io page: https://npm.io/package/@types/gifencoder

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 2.0.3 (latest) — 2023-11-07
- 2.0.1 (ts3.5) — 2021-04-17
- 2.0.0 (ts3.1) — 2020-09-08
- 2.0.2 — 2023-10-18

## README

# Installation
> `npm install --save @types/gifencoder`

# Summary
This package contains type definitions for gifencoder (https://github.com/eugeneware/gifencoder#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gifencoder.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gifencoder/index.d.ts)
````ts
/// <reference types="node" />
import { Readable, Transform } from "stream";

declare class GIFEncoder {
    constructor(width: number, height: number);

    createReadStream(): Readable;
    createWriteStream(options: GIFEncoder.GIFOptions): Transform;

    start(): void;
    setRepeat(
        /** 0 for repeat, -1 for no-repeat */
        repeat: number,
    ): void;
    setDelay(/** frame delay in ms */ delay: number): void;
    setQuality(/** image quality. 10 is default */ quality: number): void;
    setTransparent(color: number | string): void;
    addFrame(ctx: CanvasRenderingContext2D): void;
    finish(): void;

    out: GIFEncoder.ByteArray;
}

declare namespace GIFEncoder {
    interface GIFOptions {
        /** 0 for repeat, -1 for no-repeat */
        repeat: number;
        /** frame delay in ms */
        delay: number;
        /** image quality. 10 is default */
        quality: number;
    }

    interface ByteArray {
        data: number[];
        getData(): Buffer;
    }
}

export = GIFEncoder;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Carlos Precioso](https://github.com/cprecioso), and [Almeida](https://github.com/almeidx).

---
_Source: https://npm.io/package/@types/gifencoder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._