Skip to content

Latest commit

 

History

History
535 lines (481 loc) · 13.5 KB

README.md

File metadata and controls

535 lines (481 loc) · 13.5 KB
Raw

@toeverything/file-type

https://github.com/toeverything/file-type/actions

Usage

import { readFile } from 'node:fs'

import { FileType } from '@toeverything/file-type'

const fileType = new FileType(await readFile('path/to/file.jpg'))
console.log(fileType.mime()) // 'application/image/jpeg'
console.log(fileType.ext()) // 'jpg'

Performance

┌─────────┬───────────────────────────┬─────────────┬────────────────────┬──────────┬─────────┐
│ (index) │ Task Name                 │ ops/sec     │ Average Time (ns)  │ Margin   │ Samples │
├─────────┼───────────────────────────┼─────────────┼────────────────────┼──────────┼─────────┤
│ 0       │ '@toeverything/file-type' │ '1,554,666' │ 643.2246344556239  │ '±2.01%' │ 777334  │
│ 1       │ 'file-type'               │ '664,314'   │ 1505.3104426207442 │ '±0.38%' │ 332158  │
└─────────┴───────────────────────────┴─────────────┴────────────────────┴──────────┴─────────┘

Supported file formats

Archive

  • 7-Zip (7Z)
  • ACE
  • ALZ
  • Archived by Robert Jung (ARJ)
  • Cabinet (CAB)
  • Extensible Archive (XAR)
  • LArc (LZS)
  • LHA
  • Mozilla Archive (MAR)
  • Multi Layer Archive (MLA)
  • PMarc (PMA)
  • Roshal Archive (RAR)
  • SeqBox (SBX)
  • Squashfs
  • StuffIt (SIT)
  • StuffIt X (SITX)
  • Tape Archive (TAR)
  • UNIX archiver (archiver)
  • Windows Imaging Format (WIM)
  • ZIP
  • ZPAQ
  • cpio
  • zoo

Audio

  • 8-Bit Sampled Voice (8SVX)
  • Adaptive Multi-Rate (AMR)
  • Advanced Audio Coding (AAC)
  • Apple iTunes Audio (M4A)
  • Apple iTunes Audiobook (M4B)
  • Apple iTunes Protected Audio (M4P)
  • Au
  • Audio Codec 3 (AC-3)
  • Audio Interchange File Format (AIFF)
  • Audio Visual Research (AVR)
  • Creative Voice (VOC)
  • FastTracker 2 Extended Module (XM)
  • Flash MP4 Audio (F4A)
  • Flash MP4 Audiobook (F4B)
  • Free Lossless Audio Codec (FLAC)
  • Impulse Tracker Module (IT)
  • MPEG-1/2 Audio Layer 2 (MP2)
  • MPEG-1/2 Audio Layer 3 (MP3)
  • MPEG-4 Part 14 Audio (MP4)
  • Matroska Audio (MKA)
  • Monkey's Audio (APE)
  • Musepack (MPC)
  • Musical Instrument Digital Interface (MIDI)
  • Ogg FLAC (OGA)
  • Ogg Opus (Opus)
  • Ogg Speex (Speex)
  • Ogg Vorbis (Vorbis)
  • Qualcomm PureVoice (QCP)
  • Quite OK Audio (QOA)
  • RealAudio (RA)
  • Scream Tracker 3 Module (S3M)
  • Sony DSD Stream File (DSF)
  • SoundFont 2 (SF2)
  • Ultimate Soundtracker Module (MOD)
  • WavPack (WV)
  • Waveform Audio (WAV)
  • Windows Media Audio (WMA)

Compressed

  • BZip3 (BZ3)
  • LZ4
  • Lempel-Ziv Finite State Entropy (LZFSE)
  • Lempel-Ziv-Markov chain algorithm (LZMA)
  • Long Range ZIP (LRZIP)
  • Snappy
  • UNIX compress (compress)
  • XZ
  • Zstandard (zstd)
  • bzip (BZ)
  • bzip2 (BZ2)
  • gzip (GZ)
  • lzip (LZ)
  • lzop (LZO)
  • rzip (RZ)

Database

  • Microsoft Access 2007 Database (ACCDB)
  • Microsoft Access Database (MDB)
  • Microsoft Works Database (WDB)
  • OpenDocument Database (ODB)
  • SQLite 3

Diagram

  • Circuit Diagram Document (CDDX)
  • Microsoft Visio Drawing (VSD)
  • Office Open XML Drawing (VSDX)
  • StarChart (SDS)
  • draw.io (DRAWIO)

Disk

  • Amiga Disk File (ADF)
  • Apple Disk Image (DMG)
  • ISO 9660 (ISO)
  • Microsoft Virtual Hard Disk (VHD)
  • Microsoft Virtual Hard Disk 2 (VHDX)
  • QEMU Copy On Write (QCOW)
  • Virtual Machine Disk (VMDK)
  • VirtualBox Virtual Disk Image (VDI)

Document

  • AbiWord (ABW)
  • AbiWord Template (AWT)
  • Adobe InDesign Document (INDD)
  • DjVu
  • InDesign Markup Language (IDML)
  • LaTeX (TeX)
  • Microsoft Publisher Document (PUB)
  • Microsoft Word Document (DOC)
  • Microsoft Works Word Processor (WPS)
  • Microsoft Write (WRI)
  • Office Open XML Document (DOCX)
  • OpenDocument Text (ODT)
  • OpenDocument Text Master (ODM)
  • OpenDocument Text Master Template (OTM)
  • OpenDocument Text Template (OTT)
  • OpenXPS (OXPS)
  • Portable Document Format (PDF)
  • PostScript (PS)
  • Rich Text Format (RTF)
  • StarWriter (SDW)
  • Sun XML Writer (SXW)
  • Sun XML Writer Global (SGW)
  • Sun XML Writer Template (STW)
  • Uniform Office Format Text (UOT)
  • WordPerfect Document (WPD)

Ebook

  • Broad Band eBook (BBeB)
  • Electronic Publication (EPUB)
  • FictionBook (FB2)
  • FictionBook ZIP (FBZ)
  • Microsoft Reader (LIT)
  • Mobipocket (MOBI)

Executable

  • Commodore 64 Program (PRG)
  • Common Object File Format (COFF)
  • Dalvik Executable (DEX)
  • Dynamic Link Library (DLL)
  • Executable and Linkable Format (ELF)
  • Java Class
  • LLVM Bitcode (BC)
  • Linear Executable (LE)
  • Lua Bytecode
  • MS-DOS Executable (EXE)
  • Mach-O
  • New Executable (NE)
  • Nintendo Switch Executable (NSO)
  • Optimized Dalvik Executable (DEY)
  • Portable Executable (PE)
  • WebAssembly Binary (Wasm)
  • Xbox 360 Executable (XEX)
  • Xbox Executable (XBE)

Font

  • BMFont ASCII (FNT)
  • BMFont Binary (FNT)
  • Embedded OpenType (EOT)
  • OpenType (OTF)
  • TrueType (TTF)
  • Web Open Font Format (WOFF)
  • Web Open Font Format 2 (WOFF2)

Formula

  • Mathematical Markup Language (MathML)
  • OpenDocument Formula (ODF)
  • OpenDocument Formula Template (OTF)
  • StarMath (SMF)
  • Sun XML Math (SXM)

Geospatial

  • Flexible and Interoperable Data Transfer (FIT)
  • GPS Exchange Format (GPX)
  • Geography Markup Language (GML)
  • Keyhole Markup Language (KML)
  • Keyhole Markup Language ZIP (KMZ)
  • Shapefile (SHP)
  • Training Center XML (TCX)

Image

  • AV1 Image File Format (AVIF)
  • AV1 Image File Format Sequence (AVIFS)
  • Adaptable Scalable Texture Compression (ASTC)
  • Adobe Illustrator Artwork (AI)
  • Adobe Photoshop Document (PSD)
  • Animated Portable Network Graphics (APNG)
  • Apple Icon Image (ICNS)
  • Better Portable Graphics (BPG)
  • Canon Raw (CRW)
  • Canon Raw 2 (CR2)
  • Canon Raw 3 (CR3)
  • Cineon (CIN)
  • Digital Picture Exchange (DPX)
  • Encapsulated PostScript (EPS)
  • Experimental Computing Facility (XCF)
  • Free Lossless Image Format (FLIF)
  • Fujifilm Raw (RAF)
  • Graphics Interchange Format (GIF)
  • High Efficiency Image Coding (HEIC)
  • High Efficiency Image Coding Sequence (HEICS)
  • High Efficiency Image File Format (HEIF)
  • High Efficiency Image File Format Sequence (HEIFS)
  • JPEG 2000 Codestream (J2C)
  • JPEG 2000 Part 1 (JP2)
  • JPEG 2000 Part 2 (JPX)
  • JPEG 2000 Part 6 (JPM)
  • JPEG Extended Range (JXR)
  • JPEG Network Graphics (JNG)
  • JPEG XL (JXL)
  • JPEG-LS (JLS)
  • Joint Photographic Experts Group (JPEG)
  • Khronos Texture (KTX)
  • Khronos Texture 2 (KTX2)
  • Magick Image File Format (MIFF)
  • Microsoft DirectDraw Surface (DDS)
  • Multiple-image Network Graphics (MNG)
  • Nikon Electronic File (NEF)
  • Olympus Raw Format (ORF)
  • OpenDocument Graphics (ODG)
  • OpenDocument Graphics Template (OTG)
  • OpenEXR (EXR)
  • OpenRaster (ORA)
  • Panasonic Raw (RW2)
  • Picture Exchange (PCX)
  • Portable Arbitrary Map (PAM)
  • Portable BitMap (PBM)
  • Portable FloatMap (PFM)
  • Portable GrayMap (PGM)
  • Portable Network Graphics (PNG)
  • Portable PixMap (PPM)
  • Quite OK Image (QOI)
  • Radiance HDR (HDR)
  • Scalable Vector Graphics (SVG)
  • Silicon Graphics Image (SGI)
  • StarDraw (SDA)
  • Sun XML Draw (SXD)
  • Sun XML Draw Template (STD)
  • Tag Image File Format (TIFF)
  • WebP
  • Windows Animated Cursor (ANI)
  • Windows Bitmap (BMP)
  • Windows Cursor (CUR)
  • Windows Icon (ICO)
  • Windows Metafile (WMF)
  • WordPerfect Graphics (WPG)
  • X PixMap (XPM)
  • farbfeld (FF)

Metadata

  • Android Binary XML (AXML)
  • BitTorrent (Torrent)
  • CD Audio (CDA)
  • Meta Information Encapsulation (MIE)
  • TASTy
  • Windows Shortcut (LNK)
  • macOS Alias

Model

  • 3D Manufacturing Format (3MF)
  • 3D Studio (3DS)
  • 3D Studio Max (MAX)
  • Additive Manufacturing Format (AMF)
  • AutoCAD Drawing (DWG)
  • Autodesk 123D (123DX)
  • Autodesk Alias (WIRE)
  • Autodesk Inventor Assembly (IAM)
  • Autodesk Inventor Drawing (IDW)
  • Autodesk Inventor Part (IPT)
  • Autodesk Inventor Presentation (IPN)
  • Blender (BLEND)
  • Cinema 4D (C4D)
  • Collaborative Design Activity (COLLADA)
  • Design Web Format (DWF)
  • Design Web Format XPS (DWFX)
  • Drawing Exchange Format ASCII (DXF)
  • Drawing Exchange Format Binary (DXF)
  • Extensible 3D (X3D)
  • Filmbox (FBX)
  • Fusion 360 (F3D)
  • GL Transmission Format Binary (GLB)
  • Google Draco (Draco)
  • Initial Graphics Exchange Specification (IGES)
  • Inter-Quake Export (IQE)
  • Inter-Quake Model (IQM)
  • MagicaVoxel (VOX)
  • Maya ASCII (MA)
  • Maya Binary (MB)
  • Model 3D ASCII (A3D)
  • Model 3D Binary (M3D)
  • Polygon ASCII (PLY)
  • Polygon Binary (PLY)
  • SketchUp (SKP)
  • SolidWorks Assembly (SLDASM)
  • SolidWorks Drawing (SLDDRW)
  • SolidWorks Part (SLDPRT)
  • SpaceClaim Document (SCDOC)
  • Standard for the Exchange of Product model data (STEP)
  • Stereolithography ASCII (STL)
  • Universal 3D (U3D)
  • Universal Scene Description ASCII (USDA)
  • Universal Scene Description Binary (USDC)
  • Universal Scene Description ZIP (USDZ)
  • Virtual Reality Modeling Language (VRML)
  • openNURBS (3DM)

Other

  • ActiveMime (MSO)
  • Advanced Systems Format (ASF)
  • Android Resource Storage Container (ARSC)
  • Apache Arrow Columnar (Arrow)
  • Apache Avro (Avro)
  • Apache Parquet (Parquet)
  • Arbitrary Binary Data (BIN)
  • Atom
  • Clojure Script
  • Compound File Binary (CFB)
  • DER Certificate (DER)
  • Digital Imaging and Communications in Medicine (DICOM)
  • Empty
  • Extensible Binary Meta Language (EBML)
  • Extensible Markup Language (XML)
  • Extensible Stylesheet Language Transformations (XSLT)
  • Flash CS5 Project (FLA)
  • Flash Project (FLA)
  • Flexible Image Transport System (FITS)
  • HyperText Markup Language (HTML)
  • ICC Profile (ICC)
  • JSON Feed
  • Java KeyStore (JKS)
  • Lua Script
  • MPEG-4 Part 14 (MP4)
  • MS-DOS Batch (Batch)
  • Microsoft Compiled HTML Help (CHM)
  • Microsoft Project Plan (MPP)
  • Microsoft Visual Studio Solution (SLN)
  • MusicXML
  • MusicXML ZIP (MXL)
  • Ogg Multiplexed Media (OGX)
  • PCAP Dump (PCAP)
  • PCAP Next Generation Dump (PCAPNG)
  • PEM Certificate (PEM)
  • PEM Certificate Signing Request (PEM)
  • PEM Private Key (PEM)
  • PEM Public Key (PEM)
  • PGP Message (PGP)
  • PGP Private Key Block (PGP)
  • PGP Public Key Block (PGP)
  • PGP Signature (PGP)
  • PGP Signed Message (PGP)
  • Perl Script
  • Personal Storage Table (PST)
  • Plain Text (TXT)
  • Python Script
  • RealMedia (RM)
  • Really Simple Syndication (RSS)
  • Ruby Script
  • Shell Script
  • Simple Object Access Protocol (SOAP)
  • Small Web Format (SWF)
  • Tiled Map XML (TMX)
  • Tiled Tileset XML (TSX)
  • Tool Command Language Script (Tcl Script)
  • WebAssembly Text (WAT)
  • WordPerfect Macro (WPM)
  • XML Localization Interchange File Format (XLIFF)
  • gettext Machine Object (MO)
  • iCalendar (ICS)
  • vCalendar (VCS)
  • vCard (VCF)

Package

  • Adobe Integrated Runtime (AIR)
  • Android App Bundle (AAB)
  • Android Package (APK)
  • AppImage
  • Debian Package (DEB)
  • Enterprise Application Archive (EAR)
  • Google Chrome Extension (CRX)
  • Java Archive (JAR)
  • Microsoft Software Installer (MSI)
  • Microsoft Visual Studio Extension (VSIX)
  • Nintendo Switch Package (NSP)
  • Red Hat Package Manager (RPM)
  • Web Application Archive (WAR)
  • Windows App Bundle (APPXBUNDLE)
  • Windows App Package (APPX)
  • XAP
  • XPInstall (XPI)
  • iOS App Store Package (IPA)

Playlist

  • Advanced Stream Redirector (ASX)
  • MP3 URL (M3U)
  • MPEG-DASH MPD (MPD)
  • SHOUTcast Playlist (PLS)
  • Windows Media Playlist (WPL)
  • XML Shareable Playlist Format (XSPF)

Presentation

  • Corel Presentations (SHW)
  • Corel Presentations 7 (SHW)
  • Microsoft PowerPoint Presentation (PPT)
  • Office Open XML Presentation (PPTX)
  • OpenDocument Presentation (ODP)
  • OpenDocument Presentation Template (OTP)
  • StarImpress (SDD)
  • Sun XML Impress (SXI)
  • Sun XML Impress Template (STI)
  • Uniform Office Format Presentation (UOP)
  • WordPerfect Presentations (SHW)

ROM

  • Atari 7800 ROM (A78)
  • Commodore 64 Cartridge (CRT)
  • Game Boy Advance ROM (GBA)
  • Game Boy Color ROM (GBC)
  • Game Boy ROM (GB)
  • Game Gear ROM (GG)
  • Mega Drive ROM (MD)
  • Neo Geo Pocket Color ROM (NGC)
  • Neo Geo Pocket ROM (NGP)
  • Nintendo 64 ROM (Z64)
  • Nintendo DS ROM (NDS)
  • Nintendo Entertainment System ROM (NES)
  • Nintendo Switch ROM (XCI)
  • Sega Master System ROM (SMS)

Spreadsheet

  • Microsoft Excel Spreadsheet (XLS)
  • Microsoft Works 6 Spreadsheet (XLR)
  • Microsoft Works Spreadsheet (WKS)
  • Office Open XML Spreadsheet (XLSX)
  • OpenDocument Spreadsheet (ODS)
  • OpenDocument Spreadsheet Template (OTS)
  • StarCalc (SDC)
  • Sun XML Calc (SXC)
  • Sun XML Calc Template (STC)
  • Uniform Office Format Spreadsheet (UOS)

Subtitle

  • MPEG-4 Part 14 Subtitles (MP4)
  • Matroska Subtitles (MKS)
  • SubRip Text (SRT)
  • Timed Text Markup Language (TTML)
  • Universal Subtitle Format (USF)
  • Web Video Text Tracks (WebVTT)

Video

  • 3rd Generation Partnership Project (3GPP)
  • 3rd Generation Partnership Project 2 (3GPP2)
  • Actions Media Video (AMV)
  • Apple QuickTime (MOV)
  • Apple iTunes Video (M4V)
  • Audio Video Interleave (AVI)
  • Autodesk Animator (FLI)
  • Autodesk Animator Pro (FLC)
  • BDAV MPEG-2 Transport Stream (M2TS)
  • Flash MP4 Protected Video (F4P)
  • Flash MP4 Video (F4V)
  • Flash Video (FLV)
  • JPEG 2000 Part 3 (MJ2)
  • MPEG-1/2 Video (MPG)
  • MPEG-2 Transport Stream (TS)
  • MPEG-4 Part 14 Video (MP4)
  • MTV
  • Material Exchange Format (MXF)
  • Matroska 3D Video (MK3D)
  • Matroska Video (MKV)
  • Microsoft Digital Video Recording (DVR-MS)
  • Ogg Media (OGM)
  • Ogg Theora (Theora)
  • RealVideo (RV)
  • Silicon Graphics Movie (SGI)
  • Sony Movie (MQV)
  • WebM
  • Windows Media Video (WMV)
  • Windows Recorded TV Show (WTV)