This is a large database of mime types and information about them. 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:
npm install mime-db
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.
.extensions- known extensions associated with this mime type.
.compressible- whether a file of this type can be gzipped.
.charset- the default charset associated with this type, if any.
If unknown, every property could be
To edit the database, only make PRs against
src/custom-types.json file is a JSON object with the MIME type as the
keys and the values being an object with the following keys:
compressible- leave out if you don't know, otherwise
falseto indicate whether the data represented by the type is typically compressible.
extensions- include an array of file extensions that are associated with the type.
notes- human-readable notes about the type, typically what the type is.
sources- include an array of URLs of where the MIME type and the associated extensions are sourced from. This needs to be a primary source; links to type aggregating sites and Wikipedia are not acceptable.
To update the build, run
npm run build.
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.
If that is not possible / feasible, they can be added directly here as a "custom" type. To do this, it is required to have a primary source that definitively lists the media type. If an extension is going to be listed as associateed with this media type, the source must definitively link the media type and extension as well.