CoolFace
Apppublic

HarshvardhanCn01/Voice-Assistant

sourceHugging Faceupdated 2y agoView on Hugging Face
0likes
README.md101 linesDownload Raw Back to mime-db
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- http://www.iana.org/assignments/media-types/media-types.xhtml15- http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types16- http://hg.nginx.org/nginx/raw-file/default/conf/mime.types17 18## Installation19 20```bash21npm install mime-db22```23 24### Database Download25 26If you're crazy enough to use this in the browser, you can just grab the27JSON file using [jsDelivr](https://www.jsdelivr.com/). It is recommended to28replace `master` with [a release tag](https://github.com/jshttp/mime-db/tags)29as the JSON format may change in the future.30 31```32https://cdn.jsdelivr.net/gh/jshttp/mime-db@master/db.json33```34 35## Usage36 37```js38var db = require('mime-db')39 40// grab data on .js files41var data = db['application/javascript']42```43 44## Data Structure45 46The JSON file is a map lookup for lowercased mime types.47Each mime type has the following properties:48 49- `.source` - where the mime type is defined.50    If not set, it's probably a custom media type.51    - `apache` - [Apache common media types](http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types)52    - `iana` - [IANA-defined media types](http://www.iana.org/assignments/media-types/media-types.xhtml)53    - `nginx` - [nginx media types](http://hg.nginx.org/nginx/raw-file/default/conf/mime.types)54- `.extensions[]` - known extensions associated with this mime type.55- `.compressible` - whether a file of this type can be gzipped.56- `.charset` - the default charset associated with this type, if any.57 58If unknown, every property could be `undefined`.59 60## Contributing61 62To edit the database, only make PRs against `src/custom-types.json` or63`src/custom-suffix.json`.64 65The `src/custom-types.json` file is a JSON object with the MIME type as the66keys and the values being an object with the following keys:67 68- `compressible` - leave out if you don't know, otherwise `true`/`false` to69  indicate whether the data represented by the type is typically compressible.70- `extensions` - include an array of file extensions that are associated with71  the type.72- `notes` - human-readable notes about the type, typically what the type is.73- `sources` - include an array of URLs of where the MIME type and the associated74  extensions are sourced from. This needs to be a [primary source](https://en.wikipedia.org/wiki/Primary_source);75  links to type aggregating sites and Wikipedia are _not acceptable_.76 77To update the build, run `npm run build`.78 79### Adding Custom Media Types80 81The best way to get new media types included in this library is to register82them with the IANA. The community registration procedure is outlined in83[RFC 6838 section 5](http://tools.ietf.org/html/rfc6838#section-5). Types84registered with the IANA are automatically pulled into this library.85 86If that is not possible / feasible, they can be added directly here as a87"custom" type. To do this, it is required to have a primary source that88definitively lists the media type. If an extension is going to be listed as89associateed with this media type, the source must definitively link the90media type and extension as well.91 92[ci-image]: https://badgen.net/github/checks/jshttp/mime-db/master?label=ci93[ci-url]: https://github.com/jshttp/mime-db/actions?query=workflow%3Aci94[coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/mime-db/master95[coveralls-url]: https://coveralls.io/r/jshttp/mime-db?branch=master96[node-image]: https://badgen.net/npm/node/mime-db97[node-url]: https://nodejs.org/en/download98[npm-downloads-image]: https://badgen.net/npm/dm/mime-db99[npm-url]: https://npmjs.org/package/mime-db100[npm-version-image]: https://badgen.net/npm/v/mime-db101