@types/png.js v0.2.3

Installation

npm install --save @types/png.js

Summary

This package contains type definitions for png.js (https://github.com/arian/pngjs).

Details

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

index.d.ts

// Type definitions for png.js 0.2
// Project: https://github.com/arian/pngjs
// Definitions by: Florian Keller <https://github.com/ffflorian>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

type BitDepth = 2 | 4 | 8 | 16;
type ColorType = 0 | 2 | 3 | 4 | 6;
type ParseCallback = (err: Error | undefined, png: PNG) => void;

interface ParseOptions {
    data?: boolean | undefined;
}

declare class PNGReader {
    bytes: Uint8Array | number[] | Buffer;
    dataChunks: number[][];
    i: number;
    png: PNG;

    constructor(bytes: Uint8Array | string | Buffer | ArrayBuffer);
    parse(callback: ParseCallback): void;
    parse(options: ParseOptions, callback: ParseCallback): void;
}

declare class PNG {
    alpha: boolean;
    bitDepth: BitDepth;
    colors: number;
    colorType: ColorType;
    compressionMethod: 0;
    filterMethod: 0;
    height: number;
    interlaceMethod: 0 | 1;
    palette: number[] | null;
    pixelBits: number;
    pixels: Buffer | null;
    width: number;

    getBitDepth(): BitDepth;
    getColorType(): ColorType;
    getCompressionMethod(): 0;
    getFilterMethod(): 0;
    getHeight(): number;
    getInterlaceMethod(): 0 | 1;
    getPalette(): number[];
    getPixel(x: number, y: number): [number, number, number, number];
    getWidth(): number;
    setBitDepth(bitDepth: BitDepth): void;
    setColorType(colorType: ColorType): void;
    setCompressionMethod(compressionMethod: 0): void;
    setFilterMethod(filterMethod: 0): void;
    setHeight(height: number): void;
    setInterlaceMethod(interlaceMethod: 0 | 1): void;
    setPalette(palette: number[]): void;
    setWidth(width: number): void;
}

export = PNGReader;

Additional Details

• Last updated: Thu, 08 Jul 2021 20:19:41 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Florian Keller.