device_home/node_modules/mime-db/README.md

   1 # mime-db
   2
   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][travis-image]][travis-url]
   7 [![Coverage Status][coveralls-image]][coveralls-url]
   8
   9 This is a database of all mime types.
  10 It consists of a single, public JSON file and does not include any logic,
  11 allowing it to remain as un-opinionated as possible with an API.
  12 It aggregates data from the following sources:
  13
  14 - http://www.iana.org/assignments/media-types/media-types.xhtml
  15 - http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types
  16 - http://hg.nginx.org/nginx/raw-file/default/conf/mime.types
  17
  18 ## Installation
  19
  20 ```bash
  21 npm install mime-db
  22 ```
  23
  24 ### Database Download
  25
  26 If you're crazy enough to use this in the browser, you can just grab the
  27 JSON file using [jsDelivr](https://www.jsdelivr.com/). It is recommended to
  28 replace `master` with [a release tag](https://github.com/jshttp/mime-db/tags)
  29 as the JSON format may change in the future.
  30
  31 ```
  32 https://cdn.jsdelivr.net/gh/jshttp/mime-db@master/db.json
  33 ```
  34
  35 ## Usage
  36
  37 <!-- eslint-disable no-unused-vars -->
  38
  39 ```js
  40 var db = require('mime-db')
  41
  42 // grab data on .js files
  43 var data = db['application/javascript']
  44 ```
  45
  46 ## Data Structure
  47
  48 The JSON file is a map lookup for lowercased mime types.
  49 Each mime type has the following properties:
  50
  51 - `.source` - where the mime type is defined.
  52     If not set, it's probably a custom media type.
  53     - `apache` - [Apache common media types](http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types)
  54     - `iana` - [IANA-defined media types](http://www.iana.org/assignments/media-types/media-types.xhtml)
  55     - `nginx` - [nginx media types](http://hg.nginx.org/nginx/raw-file/default/conf/mime.types)
  56 - `.extensions[]` - known extensions associated with this mime type.
  57 - `.compressible` - whether a file of this type can be gzipped.
  58 - `.charset` - the default charset associated with this type, if any.
  59
  60 If unknown, every property could be `undefined`.
  61
  62 ## Contributing
  63
  64 To edit the database, only make PRs against `src/custom-types.json` or
  65 `src/custom-suffix.json`.
  66
  67 The `src/custom-types.json` file is a JSON object with the MIME type as the
  68 keys and the values being an object with the following keys:
  69
  70 - `compressible` - leave out if you don't know, otherwise `true`/`false` to
  71   indicate whether the data represented by the type is typically compressible.
  72 - `extensions` - include an array of file extensions that are associated with
  73   the type.
  74 - `notes` - human-readable notes about the type, typically what the type is.
  75 - `sources` - include an array of URLs of where the MIME type and the associated
  76   extensions are sourced from. This needs to be a [primary source](https://en.wikipedia.org/wiki/Primary_source);
  77   links to type aggregating sites and Wikipedia are _not acceptable_.
  78
  79 To update the build, run `npm run build`.
  80
  81 ### Adding Custom Media Types
  82
  83 The best way to get new media types included in this library is to register
  84 them with the IANA. The community registration procedure is outlined in
  85 [RFC 6838 section 5](http://tools.ietf.org/html/rfc6838#section-5). Types
  86 registered with the IANA are automatically pulled into this library.
  87
  88 If that is not possible / feasible, they can be added directly here as a
  89 "custom" type. To do this, it is required to have a primary source that
  90 definitively lists the media type. If an extension is going to be listed as
  91 associateed with this media type, the source must definitively link the
  92 media type and extension as well.
  93
  94 [coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/mime-db/master
  95 [coveralls-url]: https://coveralls.io/r/jshttp/mime-db?branch=master
  96 [node-image]: https://badgen.net/npm/node/mime-db
  97 [node-url]: https://nodejs.org/en/download
  98 [npm-downloads-image]: https://badgen.net/npm/dm/mime-db
  99 [npm-url]: https://npmjs.org/package/mime-db
 100 [npm-version-image]: https://badgen.net/npm/v/mime-db
 101 [travis-image]: https://badgen.net/travis/jshttp/mime-db/master
 102 [travis-url]: https://travis-ci.org/jshttp/mime-db