@types/pngjs

  • Version 6.0.4
  • Published
  • 5.45 kB
  • 1 dependency
  • MIT license

Install

npm i @types/pngjs
yarn add @types/pngjs
pnpm add @types/pngjs

Overview

TypeScript definitions for pngjs

Index

Classes

class PNG

class PNG extends Duplex {}

    constructor

    constructor(options?: PNGOptions);

      property data

      data: Buffer;

        property gamma

        gamma: number;

          property height

          height: number;

            property sync

            static sync: {
            read(buffer: Buffer, options?: ParserOptions): PNGWithMetadata;
            write(png: PNG, options?: PackerOptions): Buffer;
            };

              property width

              width: number;

                method adjustGamma

                static adjustGamma: (src: PNG) => void;

                  method bitblt

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

                    method on

                    on: {
                    (event: 'metadata', callback: (this: PNG, metadata: Metadata) => void): this;
                    (event: 'parsed', callback: (this: PNG, data: Buffer) => void): this;
                    (event: 'error', callback: (this: PNG, error: Error) => void): this;
                    (event: 'close', callback: (this: PNG) => void): this;
                    (event: string, callback: (this: PNG, ...args: any[]) => void): this;
                    };

                      method pack

                      pack: () => PNG;

                        method parse

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

                          Interfaces

                          interface BaseOptions

                          interface BaseOptions {}

                            property fill

                            fill?: boolean | undefined;

                              property height

                              height?: number | undefined;

                                property width

                                width?: number | undefined;

                                  interface Metadata

                                  interface Metadata {}

                                    property alpha

                                    alpha: boolean;

                                      property bpp

                                      bpp: 1 | 2 | 3 | 4;

                                        property color

                                        color: boolean;

                                          property colorType

                                          colorType: ColorType;

                                            property depth

                                            depth: 1 | 2 | 4 | 8 | 16;

                                              property height

                                              height: number;

                                                property interlace

                                                interlace: boolean;

                                                  property palette

                                                  palette: boolean;

                                                    property width

                                                    width: number;

                                                      interface PackerOptions

                                                      interface PackerOptions {}

                                                        property bgColor

                                                        bgColor?:
                                                        | {
                                                        red: number;
                                                        green: number;
                                                        blue: number;
                                                        }
                                                        | undefined;

                                                          property bitDepth

                                                          bitDepth?: BitDepth | undefined;

                                                            property colorType

                                                            colorType?: ColorType | undefined;

                                                              property deflateChunkSize

                                                              deflateChunkSize?: number | undefined;

                                                                property deflateFactory

                                                                deflateFactory?: typeof createDeflate | undefined;

                                                                  property deflateLevel

                                                                  deflateLevel?: number | undefined;

                                                                    property deflateStrategy

                                                                    deflateStrategy?: number | undefined;

                                                                      property filterType

                                                                      filterType?: number | number[] | undefined;

                                                                        property inputColorType

                                                                        inputColorType?: ColorType | undefined;

                                                                          property inputHasAlpha

                                                                          inputHasAlpha?: boolean | undefined;

                                                                            interface ParserOptions

                                                                            interface ParserOptions {}

                                                                              property checkCRC

                                                                              checkCRC?: boolean | undefined;

                                                                                property skipRescale

                                                                                skipRescale?: boolean | undefined;

                                                                                  Type Aliases

                                                                                  type BitDepth

                                                                                  type BitDepth = 8 | 16;

                                                                                    type ColorType

                                                                                    type ColorType = 0 | 2 | 4 | 6;

                                                                                      type PNGOptions

                                                                                      type PNGOptions = BaseOptions & ParserOptions & PackerOptions;

                                                                                        type PNGWithMetadata

                                                                                        type PNGWithMetadata = PNG & Metadata;

                                                                                          Package Files (1)

                                                                                          Dependencies (1)

                                                                                          Dev Dependencies (0)

                                                                                          No dev dependencies.

                                                                                          Peer Dependencies (0)

                                                                                          No peer dependencies.

                                                                                          Badge

                                                                                          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/pngjs.

                                                                                          • Markdown
                                                                                            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/pngjs)
                                                                                          • HTML
                                                                                            <a href="https://www.jsdocs.io/package/@types/pngjs"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>