AK-21/Graphite-Industrial-Intelligence

1# mime-db2 3[![NPM Version][npm-version-image]][npm-url]4[![NPM Downloads][npm-downloads-image]][npm-url]5[![Node.js Version][node-image]][node-url]6[![Build Status][ci-image]][ci-url]7[![Coverage Status][coveralls-image]][coveralls-url]8 9This is a large database of mime types and information about them.10It consists of a single, public JSON file and does not include any logic,11allowing it to remain as un-opinionated as possible with an API.12It aggregates data from the following sources:13 14- https://www.iana.org/assignments/media-types/media-types.xhtml15- https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types16- https://hg.nginx.org/nginx/raw-file/default/conf/mime.types17 18## Installation19 20```bash21npm install mime-db22```23 24### Database Download25 26If 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.27 28```29https://cdn.jsdelivr.net/gh/jshttp/mime-db@master/db.json30```31 32## Usage33 34```js35var db = require('mime-db')36 37// grab data on .js files38var data = db['application/javascript']39```40 41## Data Structure42 43The JSON file is a map lookup for lowercased mime types.44Each mime type has the following properties:45 46- `.source` - where the mime type is defined.47    If not set, it's probably a custom media type.48    - `apache` - [Apache common media types](https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types)49    - `iana` - [IANA-defined media types](https://www.iana.org/assignments/media-types/media-types.xhtml)50    - `nginx` - [nginx media types](https://hg.nginx.org/nginx/raw-file/default/conf/mime.types)51- `.extensions[]` - known extensions associated with this mime type.52- `.compressible` - whether a file of this type can be gzipped.53- `.charset` - the default charset associated with this type, if any.54 55If unknown, every property could be `undefined`.56 57## Note on MIME Type Data and Semver58 59This package considers the programmatic api as the semver compatibility. This means the MIME type resolution is *not* considered60in the semver bumps. This means that if you want to pin your `mime-db` data you will need to do it in your application. While61this expectation was not set in docs until now, it is how the pacakge operated, so we do not feel this is a breaking change.62 63## Contributing64 65The primary way to contribute to this database is by updating the data in66one of the upstream sources. The database is updated from the upstreams67periodically and will pull in any changes.68 69### Registering Media Types70 71The best way to get new media types included in this library is to register72them with the IANA. The community registration procedure is outlined in73[RFC 6838 section 5](https://tools.ietf.org/html/rfc6838#section-5). Types74registered with the IANA are automatically pulled into this library.75 76### Direct Inclusion77 78If that is not possible / feasible, they can be added directly here as a79"custom" type. To do this, it is required to have a primary source that80definitively lists the media type. If an extension is going to be listed as81associated with this media type, the source must definitively link the82media type and extension as well.83 84To edit the database, only make PRs against `src/custom-types.json` or85`src/custom-suffix.json`.86 87The `src/custom-types.json` file is a JSON object with the MIME type as the88keys and the values being an object with the following keys:89 90- `compressible` - leave out if you don't know, otherwise `true`/`false` to91  indicate whether the data represented by the type is typically compressible.92- `extensions` - include an array of file extensions that are associated with93  the type.94- `notes` - human-readable notes about the type, typically what the type is.95- `sources` - include an array of URLs of where the MIME type and the associated96  extensions are sourced from. This needs to be a [primary source](https://en.wikipedia.org/wiki/Primary_source);97  links to type aggregating sites and Wikipedia are _not acceptable_.98 99To update the build, run `npm run build`.100 101[ci-image]: https://badgen.net/github/checks/jshttp/mime-db/master?label=ci102[ci-url]: https://github.com/jshttp/mime-db/actions/workflows/ci.yml103[coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/mime-db/master104[coveralls-url]: https://coveralls.io/r/jshttp/mime-db?branch=master105[node-image]: https://badgen.net/npm/node/mime-db106[node-url]: https://nodejs.org/en/download107[npm-downloads-image]: https://badgen.net/npm/dm/mime-db108[npm-url]: https://npmjs.org/package/mime-db109[npm-version-image]: https://badgen.net/npm/v/mime-db110