| | |
|---|
| | | allowing it to remain as un-opinionated as possible with an API. |
|---|
| | | It aggregates data from the following sources: |
|---|
| | | |
|---|
| | | - http://www.iana.org/assignments/media-types/media-types.xhtml |
|---|
| | | - http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types |
|---|
| | | - http://hg.nginx.org/nginx/raw-file/default/conf/mime.types |
|---|
| | | - https://www.iana.org/assignments/media-types/media-types.xhtml |
|---|
| | | - https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types |
|---|
| | | - https://hg.nginx.org/nginx/raw-file/default/conf/mime.types |
|---|
| | | |
|---|
| | | ## Installation |
|---|
| | | |
|---|
| | |
|---|
| | | |
|---|
| | | ### Database Download |
|---|
| | | |
|---|
| | | If you're crazy enough to use this in the browser, you can just grab the |
|---|
| | | JSON file using [jsDelivr](https://www.jsdelivr.com/). It is recommended to |
|---|
| | | replace `master` with [a release tag](https://github.com/jshttp/mime-db/tags) |
|---|
| | | as the JSON format may change in the future. |
|---|
| | | If you intend to use this in a web browser, you can conveniently access the JSON file via [jsDelivr](https://www.jsdelivr.com/), a popular CDN (Content Delivery Network). To ensure stability and compatibility, it is advisable to specify [a release tag](https://github.com/jshttp/mime-db/tags) instead of using the 'master' branch. This is because the JSON file's format might change in future updates, and relying on a specific release tag will prevent potential issues arising from these changes. |
|---|
| | | |
|---|
| | | ``` |
|---|
| | | https://cdn.jsdelivr.net/gh/jshttp/mime-db@master/db.json |
|---|
| | |
|---|
| | | |
|---|
| | | - `.source` - where the mime type is defined. |
|---|
| | | If not set, it's probably a custom media type. |
|---|
| | | - `apache` - [Apache common media types](http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types) |
|---|
| | | - `iana` - [IANA-defined media types](http://www.iana.org/assignments/media-types/media-types.xhtml) |
|---|
| | | - `nginx` - [nginx media types](http://hg.nginx.org/nginx/raw-file/default/conf/mime.types) |
|---|
| | | - `apache` - [Apache common media types](https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types) |
|---|
| | | - `iana` - [IANA-defined media types](https://www.iana.org/assignments/media-types/media-types.xhtml) |
|---|
| | | - `nginx` - [nginx media types](https://hg.nginx.org/nginx/raw-file/default/conf/mime.types) |
|---|
| | | - `.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 `undefined`. |
|---|
| | | |
|---|
| | | ## Note on MIME Type Data and Semver |
|---|
| | | |
|---|
| | | This package considers the programmatic api as the semver compatibility. This means the MIME type resolution is *not* considered |
|---|
| | | in the semver bumps. This means that if you want to pin your `mime-db` data you will need to do it in your application. While |
|---|
| | | this expectation was not set in docs until now, it is how the pacakge operated, so we do not feel this is a breaking change. |
|---|
| | | |
|---|
| | | ## Contributing |
|---|
| | | |
|---|
| | | The primary way to contribute to this database is by updating the data in |
|---|
| | | one of the upstream sources. The database is updated from the upstreams |
|---|
| | | periodically and will pull in any changes. |
|---|
| | | |
|---|
| | | ### Registering 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](https://tools.ietf.org/html/rfc6838#section-5). Types |
|---|
| | | registered with the IANA are automatically pulled into this library. |
|---|
| | | |
|---|
| | | ### Direct Inclusion |
|---|
| | | |
|---|
| | | 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 |
|---|
| | | associated with this media type, the source must definitively link the |
|---|
| | | media type and extension as well. |
|---|
| | | |
|---|
| | | To edit the database, only make PRs against `src/custom-types.json` or |
|---|
| | | `src/custom-suffix.json`. |
|---|
| | |
|---|
| | | |
|---|
| | | 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](http://tools.ietf.org/html/rfc6838#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. |
|---|
| | | |
|---|
| | | [ci-image]: https://badgen.net/github/checks/jshttp/mime-db/master?label=ci |
|---|
| | | [ci-url]: https://github.com/jshttp/mime-db/actions?query=workflow%3Aci |
|---|
| | | [ci-url]: https://github.com/jshttp/mime-db/actions/workflows/ci.yml |
|---|
| | | [coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/mime-db/master |
|---|
| | | [coveralls-url]: https://coveralls.io/r/jshttp/mime-db?branch=master |
|---|
| | | [node-image]: https://badgen.net/npm/node/mime-db |
|---|
