• Stars
    star
    304
  • Rank 137,274 (Top 3 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created about 9 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

PNG image decoder and encoder written entirely in JavaScript

fast-png

PNG image decoder and encoder written entirely in JavaScript.

Zakodium logo

Maintained by Zakodium

NPM version build status npm download

Installation

$ npm install --save fast-png

Usage

decode(png[, options])

Arguments

  • png - A TypedArray or Buffer that contains the PNG data.
  • options - An object of options

Options

  • checkCrc - If set to true, the CRC will be checked for each chunk and an error will be thrown in case it's wrong (default: false).

encode(image)

Arguments

  • png - An object representing the image. You can pass an ImageData from the Canvas API or an object with the following properties:
    • width - The width of the image
    • height - The height of the image
    • data - An array or TypedArray with the image data
    • depth - A number indicating the color depth (only 8 and 16 are supported now). Defaults to 8.
    • channels - Number of channels, including alpha (1, 2, 3 and 4 are supported). Defaults to 4.

PNG standard

Spec can be found at: https://www.w3.org/TR/PNG/

License

MIT