testing new parallax image
[josuexyz/.git] / 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 ```js
38 var db = require('mime-db');
39
40 // grab data on .js files
41 var data = db['application/javascript'];
42 ```
43
44 ## Data Structure
45
46 The JSON file is a map lookup for lowercased mime types.
47 Each 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
58 If unknown, every property could be `undefined`.
59
60 ## Contributing
61
62 To edit the database, only make PRs against `src/custom.json` or
63 `src/custom-suffix.json`.
64
65 The `src/custom.json` file is a JSON object with the MIME type as the keys
66 and the values being an object with the following keys:
67
68 - `compressible` - leave out if you don't know, otherwise `true`/`false` to
69   indicate whether the data represented by the type is typically compressible.
70 - `extensions` - include an array of file extensions that are associated with
71   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 associated
74   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
77 To update the build, run `npm run build`.
78
79 ### Adding Custom Media Types
80
81 The best way to get new media types included in this library is to register
82 them with the IANA. The community registration procedure is outlined in
83 [RFC 6838 section 5](http://tools.ietf.org/html/rfc6838#section-5). Types
84 registered with the IANA are automatically pulled into this library.
85
86 If that is not possible / feasible, they can be added directly here as a
87 "custom" type. To do this, it is required to have a primary source that
88 definitively lists the media type. If an extension is going to be listed as
89 associateed with this media type, the source must definitively link the
90 media type and extension as well.
91
92 [coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/mime-db/master
93 [coveralls-url]: https://coveralls.io/r/jshttp/mime-db?branch=master
94 [node-image]: https://badgen.net/npm/node/mime-db
95 [node-url]: https://nodejs.org/en/download
96 [npm-downloads-image]: https://badgen.net/npm/dm/mime-db
97 [npm-url]: https://npmjs.org/package/mime-db
98 [npm-version-image]: https://badgen.net/npm/v/mime-db
99 [travis-image]: https://badgen.net/travis/jshttp/mime-db/master
100 [travis-url]: https://travis-ci.org/jshttp/mime-db