compile-mime-match

Compiles a function that matches a given MIME type. A faster alternative to type-is for when the MIME type is known ahead of time.

Installation

// npm
npm install compile-mime-match --save

// yarn
yarn add compile-mime-match

Usage

1const compileMimeMatch = require('compile-mime-match');
2const mimeMatch = compileMimeMatch('application/json');
3
4mimeMatch('application/json'); // true
5mimeMatch('application/json; charset=utf-8'); // true
6
7mimeMatch('text/plain'); // false

Input Formats

type/subtype

Matches exactly the given MIME type (see the example above).

type/*

Matches any MIME type will the given type.

1const compileMimeMatch = require('compile-mime-match');
2const mimeMatch = compileMimeMatch('text/*');
3
4mimeMatch('text/plain'); // true
5mimeMatch('text/html'); // true
6
7mimeMatch('image/png'); // false

*/subtype

Matches any MIME type will the given subtype.

1const compileMimeMatch = require('compile-mime-match');
2const mimeMatch = compileMimeMatch('*/xml');
3
4mimeMatch('application/xml'); // true
5mimeMatch('text/xml'); // true
6
7mimeMatch('image/svg+xml'); // false

*/*

Matches any valid MIME type.

1const compileMimeMatch = require('compile-mime-match');
2const mimeMatch = compileMimeMatch('*/*');
3
4mimeMatch('image/png'); // true
5mimeMatch('application/x-www-form-urlencoded'); // true
6
7mimeMatch('invalid'); // false
8mimeMatch('/'); // false

+suffix

Matches any valid MIME type that ends with +suffix.

1const compileMimeMatch = require('compile-mime-match');
2const mimeMatch = compileMimeMatch('+json');
3
4mimeMatch('application/calendar+json'); // true
5mimeMatch('application/geo+json'); // true
6
7mimeMatch('application/json'); // false
8mimeMatch('invalid+json'); // false

Array

compile-mime-match also accepts an array of strings to match multiple types at the same time:

1const compileMimeMatch = require('compile-mime-match');
2const mimeMatch = compileMimeMatch(['application/json', 'text/*']);
3
4mimeMatch('application/json'); // true
5mimeMatch('application/json; charset=utf-8'); // true
6mimeMatch('text/plain'); // true
7mimeMatch('text/html'); // true
8
9mimeMatch('image/png'); // false