tentakelfabrik
/
tiny-consent
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2 Commits
1 Branch
18 MiB
 
 
 
Tree: f184cd7e2a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'f184cd7e2a'
${ noResults }
tiny-consent/node_modules/file-type
Björn f184cd7e2a adding 4 years ago
..
index.d.ts adding 4 years ago
index.js adding 4 years ago
license adding 4 years ago
package.json adding 4 years ago
readme.md adding 4 years ago

readme.md

file-type Build Status

Detect the file type of a Buffer/Uint8Array/ArrayBuffer

The file type is detected by checking the magic number of the buffer.

Install

$ npm install file-type

Usage

Node.js
const readChunk = require('read-chunk');
const fileType = require('file-type');

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

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

Or from a remote location:

const http = require('http');
const fileType = require('file-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(fileType.minimumBytes);
		response.destroy();
		console.log(fileType(chunk));
		//=> {ext: 'gif', mime: 'image/gif'}
	});
});

Or from a stream:

const fs = require('fs');
const crypto = require('crypto');
const fileType = require('file-type');

(async () => {
	const read = fs.createReadStream('encrypted.enc');
	const decipher = crypto.createDecipheriv(alg, key, iv);

	const stream = await fileType.stream(read.pipe(decipher));

	console.log(stream.fileType);
	//=> {ext: 'mov', mime: 'video/quicktime'}

	const write = fs.createWriteStream(`decrypted.${stream.fileType.ext}`);
	stream.pipe(write);
})();
Browser
const xhr = new XMLHttpRequest();
xhr.open('GET', 'unicorn.png');
xhr.responseType = 'arraybuffer';

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

xhr.send();

API

fileType(input)

Returns an Object with:

Or null when there is no match.

input

Type: Buffer | Uint8Array | ArrayBuffer

It only needs the first .minimumBytes bytes. The exception is detection of docx, pptx, and xlsx which potentially requires reading the whole file.

fileType.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.

fileType.stream(readableStream)

Detect the file type of a readable stream.

Returns a Promise which resolves to the original readable stream argument, but with an added fileType property, which is an object like the one returned from fileType().

Note: This method is only for Node.js.

readableStream

Type: stream.Readable

Supported file types

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

Pull request welcome for additional commonly used file types.

Related

Created by

License

MIT