# @types/omggif

> TypeScript definitions for omggif

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

## Install

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

## 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 | 1.0.5 |
| Published | 2023-11-07 |
| First published | 2018-08-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

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

## Recent versions

- 1.0.5 (latest) — 2023-11-07
- 1.0.3 (ts3.9) — 2022-04-09
- 1.0.2 (ts3.6) — 2021-07-08
- 1.0.1 (ts3.0) — 2020-05-27
- 1.0.0 (ts2.1) — 2018-08-23
- 1.0.4 — 2023-10-18

## README

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

# Summary
This package contains type definitions for omggif (https://github.com/deanm/omggif).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/omggif.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/omggif/index.d.ts)
````ts
/**
 * Can be any type that supports the bracket accessor: Array, Uint8Array, Node Buffer, etc.
 */
export interface GifBinary {
    readonly length: number;
    [index: number]: number;
}

export interface GifOptions {
    background?: number | undefined;
    loop?: number | undefined;
    palette?: number[] | undefined;
}

export interface FrameOptions {
    delay?: number | undefined;
    disposal?: number | undefined;
    palette?: number[] | null | undefined;
    transparent?: number | undefined;
}

export interface Frame {
    data_length: number;
    data_offset: number;
    delay: number;
    disposal: number;
    has_local_palette: boolean;
    height: number;
    interlaced: boolean;
    palette_offset: number | null;
    palette_size: number | null;
    transparent_index: number | null;
    width: number;
    x: number;
    y: number;
}

export class GifWriter {
    height: number;
    width: number;
    /**
     * @param buf - Uint8Array is a common choice.
     * Can be any type that supports the bracket accessor: Array, Uint8Array, Node Buffer, etc.
     */
    constructor(buf: GifBinary, width: number, height: number, gopts?: GifOptions);

    addFrame(x: number, y: number, w: number, h: number, indexed_pixels: number[], opts?: FrameOptions): number;
    end(): number;
    getOutputBuffer(): GifBinary;
    getOutputBufferPosition(): number;
    setOutputBuffer(v: GifBinary): void;
    setOutputBufferPosition(v: number): void;
}

export class GifReader {
    height: number;
    width: number;

    /**
     * @param buf - Uint8Array is a common choice.
     * Can be any type that supports the bracket accessor: Array, Uint8Array, Node Buffer, etc.
     */
    constructor(buf: GifBinary);

    decodeAndBlitFrameBGRA(frame_num: number, pixels: number[] | Uint8Array | Uint8ClampedArray): void;
    decodeAndBlitFrameRGBA(frame_num: number, pixels: number[] | Uint8Array | Uint8ClampedArray): void;
    frameInfo(frame_num: number): Frame;
    loopCount(): number;
    numFrames(): number;
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: none

# Credits
These definitions were written by [Florian Imdahl](https://github.com/ffflorian).

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