Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

parse-png

kevva5.5mMIT2.1.0TypeScript support: included

Parse a PNG

parse, png, promise

readme

parse-png Build Status

Parse a PNG

Install

$ npm install parse-png

Usage

const fs = require('fs');
const parsePng = require('parse-png');

(async () => {
    const png = await parsePng(fs.readFileSync('unicorn.png'));

    console.log(png);
    /*
    {
        width: 200,
        height: 133,
        depth: 8,
        interlace: false,
        palette: false,
        color: true,
        alpha: false,
        bpp: 3,
        colorType: 2,
        data: <Buffer 29 48 4d ...>,
    }
    */

    png.adjustGamma();
    png.pack().pipe(fs.createWriteStream('unicorn-adjusted.png'));
})();

API

parsePng(buffer, options?)

Returns a Promise<Object> with a PNG instance. See the pngjs documentation for more information.

buffer

Type: Buffer

A PNG image buffer.

options

Type: Object

See the pngjs options.