Note

mime@4 is nowlatest. If you're upgrading frommime@3, note the following:

• mime@4 is API-compatible withmime@3, withone two exceptions:
  • Direct imports ofmime propertiesno longer supported
  • mime.define() cannot be called on the defaultmime object
• ESM module support is required.ESM Module FAQ.
• Requires anES2020 or newer runtime
• Built-in Typescript types (@types/mime no longer needed)

Installation

npm install mime

Quick Start

importmimefrom'mime';mime.getType('txt');// ⇨ 'text/plain'mime.getExtension('text/plain');// ⇨ 'txt'

Lite Version

importmimefrom'mime/lite';

API

mime.getType(pathOrExtension)

mime.getType('js');// ⇨ 'text/javascript'mime.getType('json');// ⇨ 'application/json'mime.getType('txt');// ⇨ 'text/plain'mime.getType('dir/text.txt');// ⇨ 'text/plain'mime.getType('dir\\text.txt');// ⇨ 'text/plain'mime.getType('.text.txt');// ⇨ 'text/plain'mime.getType('.txt');// ⇨ 'text/plain'

mime.getType('foo/txt');// ⇨ nullmime.getType('bogus_type');// ⇨ null

mime.getExtension(type)

mime.getExtension('text/plain');// ⇨ 'txt'mime.getExtension('application/json');// ⇨ 'json'mime.getExtension('text/html; charset=utf8');// ⇨ 'html'

mime.getAllExtensions(type)

Note

New inmime@4

mime.getAllExtensions('image/jpeg');// ⇨ Set(3) { 'jpeg', 'jpg', 'jpe' }

CustomMime instances

new Mime(type map [, type map, ...])

import{Mime}from'mime/lite';importstandardTypesfrom'mime/types/standard.js';importotherTypesfrom'mime/types/other.js';constmime=newMime(standardTypes,otherTypes);

mime.define(type map [, force = false])

Note

Only available on customMime instances

mime.define({'text/x-abc':['abc','abcd']});mime.getType('abcd');// ⇨ 'text/x-abc'mime.getExtension('text/x-abc')// ⇨ 'abc'

Command Line

Extension -> type

$ mime scripts/jquery.jstext/javascript

Type -> extension

$ mime -r image/jpegjpeg