website/node_modules/is-png/readme.md

is-png Build Status

Check if a Buffer/Uint8Array is a PNG image

Used by image-type.

Install

$ npm install --save is-png

Usage

Node.js
var readChunk = require('read-chunk'); // npm install read-chunk
var isPng = require('is-png');
var buffer = readChunk.sync('unicorn.png', 0, 8);

isPng(buffer);
//=> true
Browser
var xhr = new XMLHttpRequest();
xhr.open('GET', 'unicorn.png');
xhr.responseType = 'arraybuffer';

xhr.onload = function () {
    isPng(new Uint8Array(this.response));
    //=> true
};

xhr.send();

API

isPng(buffer)

Accepts a Buffer (Node.js) or Uint8Array.

It only needs the first 8 bytes.

License

MIT © Sindre Sorhus



JohnCoene/chirp documentation built on May 25, 2021, 6:33 p.m.