Archived

This repository has been archived on 2019-02-05. You can view files and clone it, but cannot push or open issues or pull requests.

History

Simon G f17a921ca3 Initial commit		2017-01-20 23:42:49 +01:00
..
db.json	Initial commit	2017-01-20 23:42:49 +01:00
HISTORY.md	Initial commit	2017-01-20 23:42:49 +01:00
index.js	Initial commit	2017-01-20 23:42:49 +01:00
LICENSE	Initial commit	2017-01-20 23:42:49 +01:00
package.json	Initial commit	2017-01-20 23:42:49 +01:00
README.md	Initial commit	2017-01-20 23:42:49 +01:00

README.md

mime-db

This is a database of all mime types. It consists of a single, public JSON file and does not include any logic, allowing it to remain as un-opinionated as possible with an API. It aggregates data from the following sources:

Installation

npm install mime-db

If you're crazy enough to use this in the browser, you can just grab the JSON file:

https://cdn.rawgit.com/jshttp/mime-db/master/db.json

Usage

var db = require('mime-db');

// grab data on .js files
var data = db['application/javascript'];

Data Structure

The JSON file is a map lookup for lowercased mime types. Each mime type has the following properties:

.source - where the mime type is defined. If not set, it's probably a custom media type.
- apache - Apache common media types
- iana - IANA-defined media types
.extensions[] - known extensions associated with this mime type.
.compressible - whether a file of this type is can be gzipped.
.charset - the default charset associated with this type, if any.

If unknown, every property could be undefined.

Contributing

To edit the database, only make PRs against src/custom.json or src/custom-suffix.json.

To update the build, run npm run update.

Adding Custom Media Types

The best way to get new media types included in this library is to register them with the IANA. The community registration procedure is outlined in RFC 6838 section 5. Types registered with the IANA are automatically pulled into this library.