biofriction-wp-theme/node_modules/is-png/readme.md

56 lines
949 B
Markdown

# is-png [![Build Status](https://travis-ci.org/sindresorhus/is-png.svg?branch=master)](https://travis-ci.org/sindresorhus/is-png)
> Check if a Buffer/Uint8Array is a [PNG](http://en.wikipedia.org/wiki/Portable_Network_Graphics) image
Used by [image-type](https://github.com/sindresorhus/image-type).
## Install
```sh
$ npm install --save is-png
```
## Usage
##### Node.js
```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
```js
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](http://sindresorhus.com)