file-type
    Overview
    Documentation
    Tutorials
    Insights
    Code
    Dependencies
    Contributors
    Jobs

file-type

Detect the file type of a Buffer/Uint8Array/ArrayBuffer

12.3.0  •  Updated 7 months ago  •  by Sindre Sorhus  •  MIT License

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 stream = require('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(stream.pipeline(read, 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 undefined 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

fileType.extensions

Returns a set of supported file extensions.

fileType.mimeTypes

Returns a set of supported MIME types.

Supported file types

  • jpg
  • png
  • apng - Animated Portable Network Graphics
  • gif
  • webp
  • flif
  • cr2 - Canon Raw image file (v2)
  • orf - Olympus Raw image file
  • arw - Sony Alpha Raw image file
  • dng - Adobe Digital Negative image file
  • nef - Nikon Electronic Format image file
  • rw2 - Panasonic RAW image file
  • raf - Fujifilm RAW image file
  • tif
  • bmp
  • jxr
  • psd
  • zip
  • tar
  • rar
  • gz
  • bz2
  • 7z
  • dmg
  • mp4
  • mid
  • mkv
  • webm
  • mov
  • avi
  • mpg
  • mp2
  • mp3
  • ogg
  • ogv
  • ogm
  • oga
  • spx
  • ogx
  • opus
  • flac
  • wav
  • qcp
  • amr
  • pdf
  • epub
  • mobi - Mobipocket
  • exe
  • swf
  • rtf
  • woff
  • woff2
  • eot
  • ttf
  • otf
  • ico
  • flv
  • ps
  • xz
  • sqlite
  • nes
  • crx
  • xpi
  • cab
  • deb
  • ar
  • rpm
  • Z
  • lz
  • msi
  • mxf
  • mts
  • wasm
  • blend
  • bpg
  • docx
  • pptx
  • xlsx
  • jp2 - JPEG 2000
  • jpm - JPEG 2000
  • jpx - JPEG 2000
  • mj2 - Motion JPEG 2000
  • aif
  • odt - OpenDocument for word processing
  • ods - OpenDocument for spreadsheets
  • odp - OpenDocument for presentations
  • xml
  • heic
  • cur
  • ktx
  • ape - Monkey’s Audio
  • wv - WavPack
  • asf - Advanced Systems Format
  • wma - Windows Media Audio
  • wmv - Windows Media Video
  • dcm - DICOM Image File
  • mpc - Musepack (SV7 & SV8)
  • ics - iCalendar
  • glb - GL Transmission Format
  • pcap - Libpcap File Format
  • dsf - Sony DSD Stream File (DSF)
  • lnk - Microsoft Windows file shortcut
  • alias - macOS Alias file
  • voc - Creative Voice File
  • ac3 - ATSC A/52 Audio File
  • 3gp - Multimedia container format defined by the Third Generation Partnership Project (3GPP) for 3G UMTS multimedia services
  • 3g2 - Multimedia container format defined by the 3GPP2 for 3G CDMA2000 multimedia services
  • m4v - MPEG-4 Visual bitstreams
  • m4p - MPEG-4 files with audio streams encrypted by FairPlay Digital Rights Management as were sold through the iTunes Store
  • m4a - Audio-only MPEG-4 files
  • m4b - Audiobook and podcast MPEG-4 files, which also contain metadata including chapter markers, images, and hyperlinks
  • f4v - ISO base media file format used by Adobe Flash Player
  • f4p - ISO base media file format protected by Adobe Access DRM used by Adobe Flash Player
  • f4a - Audio-only ISO base media file format used by Adobe Flash Player
  • f4b - Audiobook and podcast ISO base media file format used by Adobe Flash Player
  • mie - Dedicated meta information format which supports storage of binary as well as textual meta information.

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

Pull requests are welcome for additional commonly used file types, except for doc, xls, ppt.

Related

Maintainers


Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

Popularity

Weekly Downloads
6.2M
Stars
1.4K

Maintenance

Development

Last ver 7 months ago
Created 6 years ago
Last commit 5 months ago
7 days between commits

Technology

Node version: 10.16.0
51.6K unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

66 contributors
Sindre Sorhus
Maintainer, 160 commits, 78 merges
Kevin Martensson
19 commits, 7 merges, 3 PRs
Works at imagemin yeoman
Mikael Finstad
Maintainer, 8 commits, 6 merges, 1 PRs
Works at Freelance
Borewit
9 commits, 20 PRs
Karl Hiramoto
8 commits, 10 PRs
Yanis Benson
6 commits, 6 PRs

Tags

mime
file
type
archive
image
img
pic
picture
flash
photo
video
detect
check
is
exif
exe
binary
buffer
uint8array
jpg
png
apng
gif
webp
flif
cr2
orf
arw
dng
nef
rw2
raf
tif
bmp
jxr
psd
zip
tar
rar
gz
bz2
7z
dmg
mp4
mid
mkv
webm
mov
avi
mpg
mp2
mp3
m4a
ogg
opus
flac
wav
amr
pdf
epub
mobi
swf
rtf
woff
woff2
eot
ttf
otf
ico
flv
ps
xz
sqlite
xpi
cab
deb
ar
rpm
Z
lz
msi
mxf
mts
wasm
webassembly
blend
bpg
docx
pptx
xlsx
3gp
jp2
jpm
jpx
mj2
aif
odt
ods
odp
xml
heic
wma
ics
glb
pcap
dsf
lnk
alias
voc
ac3
3g2
m4b
m4p
m4v
f4a
f4b
f4p
f4v
mie
qcp
wmv
asf
ogv
ogm
oga
spx
ogx
ape
wv
cur
nes
crx
ktx
dcm
mpc
Openbase helps developers choose among and use millions of open-source packages, so they can build amazing products faster.
FacebookTwitterLinkedIn
© 2020 Devstore, Inc.