image-type
Detect the image type of a Buffer/Uint8Array
Last updated a year ago by sindresorhus .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install image-type 
SYNC missed versions from official npm registry.

image-type Build Status

Detect the image type of a Buffer/Uint8Array

See the file-type module for more file types and a CLI.

Install

$ npm install image-type

Usage

Node.js
const readChunk = require('read-chunk');
const imageType = require('image-type');

const buffer = readChunk.sync('unicorn.png', 0, 12);

imageType(buffer);
//=> {ext: 'png', mime: 'image/png'}

Or from a remote location:

const http = require('http');
const imageType = require('image-type');

const url = 'https://assets-cdn.github.com/images/spinners/octocat-spinner-32.gif';

http.get(url, response => {
	response.on('readable', () => {
		const chunk = response.read(imageType.minimumBytes);
		response.destroy();
		console.log(imageType(chunk));
		//=> {ext: 'gif', mime: 'image/gif'}
	});
});
Browser
const xhr = new XMLHttpRequest();
xhr.open('GET', 'unicorn.png');
xhr.responseType = 'arraybuffer';

xhr.onload = () => {
	imageType(new Uint8Array(this.response));
	//=> {ext: 'png', mime: 'image/png'}
};

xhr.send();

API

imageType(input)

Returns an Object with:

Or null when there is no match.

input

Type: Buffer | Uint8Array

It only needs the first .minimumBytes bytes.

imageType.minimumBytes

Type: number

The minimum amount of bytes needed to detect a file type. Currently, it's 4100 bytes, but it can change, so don't hardcode it.

Supported file types

SVG isn't included as it requires the whole file to be read, but you can get it here.

License

MIT © Sindre Sorhus

Current Tags

  • 4.1.0                                ...           latest (a year ago)

15 Versions

  • 4.1.0                                ...           a year ago
  • 4.0.0                                ...           a year ago
  • 3.1.0                                ...           a year ago
  • 3.0.0                                ...           3 years ago
  • 2.1.0                                ...           5 years ago
  • 2.0.2                                ...           5 years ago
  • 2.0.1                                ...           6 years ago
  • 2.0.0                                ...           6 years ago
  • 1.1.0                                ...           6 years ago
  • 1.0.0                                ...           6 years ago
  • 0.1.4                                ...           6 years ago
  • 0.1.3                                ...           6 years ago
  • 0.1.2                                ...           6 years ago
  • 0.1.1                                ...           6 years ago
  • 0.1.0                                ...           6 years ago
Maintainers (1)
Downloads
Today 2
This Week 110
This Month 185
Last Day 17
Last Week 128
Last Month 1,073
Dependencies (1)
Dev Dependencies (5)
Dependents (148)

Copyright 2014 - 2017 © taobao.org |