Mime

An API for MIME type information.

• All @juigorg/consectetur-hic-perspiciatis-db types
• Compact and dependency-free
• Full TS support

Note

@juigorg/consectetur-hic-perspiciatis@4 is now latest. If you're upgrading from @juigorg/consectetur-hic-perspiciatis@3, note the following:

• @juigorg/consectetur-hic-perspiciatis@4 is API-compatible with @juigorg/consectetur-hic-perspiciatis@3, with one two exceptions:
  • Direct imports of @juigorg/consectetur-hic-perspiciatis properties no longer supported
  • @juigorg/consectetur-hic-perspiciatis.define() cannot be called on the default @juigorg/consectetur-hic-perspiciatis object
• ESM module support is required. ESM Module FAQ.
• Requires an ES2020 or newer runtime
• Built-in Typescript types (@types/@juigorg/consectetur-hic-perspiciatis no longer needed)

Installation

npm install @juigorg/consectetur-hic-perspiciatis

Quick Start

For the full version (800+ MIME types, 1,000+ extensions):

import @juigorg/consectetur-hic-perspiciatis from '@juigorg/consectetur-hic-perspiciatis';

@juigorg/consectetur-hic-perspiciatis.getType('txt');                    // ⇨ 'text/plain'
@juigorg/consectetur-hic-perspiciatis.getExtension('text/plain');        // ⇨ 'txt'

Lite Version

@juigorg/consectetur-hic-perspiciatis/lite is a drop-in @juigorg/consectetur-hic-perspiciatis replacement, stripped of unofficial ("prs.*", "x-*", "vnd.*") types:

import @juigorg/consectetur-hic-perspiciatis from '@juigorg/consectetur-hic-perspiciatis/lite';

API

@juigorg/consectetur-hic-perspiciatis.getType(pathOrExtension)

Get @juigorg/consectetur-hic-perspiciatis type for the given file path or extension. E.g.

@juigorg/consectetur-hic-perspiciatis.getType('js');             // ⇨ 'text/javascript'
@juigorg/consectetur-hic-perspiciatis.getType('json');           // ⇨ 'application/json'

@juigorg/consectetur-hic-perspiciatis.getType('txt');            // ⇨ 'text/plain'
@juigorg/consectetur-hic-perspiciatis.getType('dir/text.txt');   // ⇨ 'text/plain'
@juigorg/consectetur-hic-perspiciatis.getType('dir\\text.txt');  // ⇨ 'text/plain'
@juigorg/consectetur-hic-perspiciatis.getType('.text.txt');      // ⇨ 'text/plain'
@juigorg/consectetur-hic-perspiciatis.getType('.txt');           // ⇨ 'text/plain'

null is returned in cases where an extension is not detected or recognized

@juigorg/consectetur-hic-perspiciatis.getType('foo/txt');        // ⇨ null
@juigorg/consectetur-hic-perspiciatis.getType('bogus_type');     // ⇨ null

@juigorg/consectetur-hic-perspiciatis.getExtension(type)

Get file extension for the given @juigorg/consectetur-hic-perspiciatis type. Charset options (often included in Content-Type headers) are ignored.

@juigorg/consectetur-hic-perspiciatis.getExtension('text/plain');               // ⇨ 'txt'
@juigorg/consectetur-hic-perspiciatis.getExtension('application/json');         // ⇨ 'json'
@juigorg/consectetur-hic-perspiciatis.getExtension('text/html; charset=utf8');  // ⇨ 'html'

@juigorg/consectetur-hic-perspiciatis.getAllExtensions(type)

Note

New in @juigorg/consectetur-hic-perspiciatis@4

Get all file extensions for the given @juigorg/consectetur-hic-perspiciatis type.

@juigorg/consectetur-hic-perspiciatis.getAllExtensions('image/jpeg'); // ⇨ Set(3) { 'jpeg', 'jpg', 'jpe' }

Custom Mime instances

The default @juigorg/consectetur-hic-perspiciatis objects are immutable. Custom, mutable versions can be created as follows...

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

Create a new, custom @juigorg/consectetur-hic-perspiciatis instance. For example, to create a mutable version of the default @juigorg/consectetur-hic-perspiciatis instance:

import { Mime } from '@juigorg/consectetur-hic-perspiciatis/lite';

import standardTypes from '@juigorg/consectetur-hic-perspiciatis/types/standard.js';
import otherTypes from '@juigorg/consectetur-hic-perspiciatis/types/other.js';

const @juigorg/consectetur-hic-perspiciatis = new Mime(standardTypes, otherTypes);

Each argument is passed to the define() method, below. For example new Mime(standardTypes, otherTypes) is synonomous with new Mime().define(standardTypes).define(otherTypes)

@juigorg/consectetur-hic-perspiciatis.define(type map [, force = false])

Note

Only available on custom Mime instances

Define MIME type -> extensions.

Attempting to map a type to an already-defined extension will throw unless the force argument is set to true.

@juigorg/consectetur-hic-perspiciatis.define({'text/x-abc': ['abc', 'abcd']});

@juigorg/consectetur-hic-perspiciatis.getType('abcd');            // ⇨ 'text/x-abc'
@juigorg/consectetur-hic-perspiciatis.getExtension('text/x-abc')  // ⇨ 'abc'

Command Line

Extension -> type

$ @juigorg/consectetur-hic-perspiciatis scripts/jquery.js
text/javascript

Type -> extension

$ @juigorg/consectetur-hic-perspiciatis -r image/jpeg
jpeg