@types/pngjs2 NPM

Installation

npm install --save @types/pngjs2

Summary

This package contains type definitions for pngjs2 (https://www.npmjs.com/package/pngjs2).

Details

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

index.d.ts

// Type definitions for pngjs2 2.0.0
// Project: https://www.npmjs.com/package/pngjs2
// Definitions by: Elisée Maurer <https://sparklinlabs.com/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference types="node" />


import fs = require("fs");
import events = require("events");
import stream = require("stream");

interface PNGOptions {
    width?: number | undefined;
    height?: number | undefined;
    checkCRC?: boolean | undefined;
    deflateChunkSize?: number | undefined;
    deflateLevel?: number | undefined;
    deflateStrategy?: number | undefined;
    deflateFactory?: any;
    filterType?: number | number[] | undefined;
    colorType?: number | undefined;
    inputHasAlpha?: boolean | undefined;
}

interface PNGMetadata {
    width: number;
    height: number;
    palette: boolean;
    color: boolean;
    alpha: boolean;
    interlace: boolean;
}

export declare class PNG extends stream.Writable {
    constructor(options?: PNGOptions);

    width: number;
    height: number;
    data: Buffer;
    gamma: number;

    on(event: string, callback: Function): this;
    on(event: "metadata", callback: (metadata: PNGMetadata) => void): this;
    on(event: "parsed", callback: (data: Buffer) => void): this;
    on(event: "error", callback: (err: Error) => void): this;

    parse(data: string | Buffer, callback?: (err: Error, data: Buffer) => void): PNG;
    pack(): PNG;

    static bitblt(src: PNG, dst: PNG, srcX: number, srcY: number,
        width: number, height: number, deltaX: number, deltaY: number): void;

    bitblt(dst: PNG, srcX: number, srcY: number,
        width: number, height: number, deltaX: number, deltaY: number): PNG;
}

export declare namespace PNG {
    namespace sync {
        function read(buffer: string | Buffer, options?: PNGOptions): PNG;
    }
}