Palak Handa / startUpJalsa-Backend

Blame view

node_modules/mime-db/README.md 2.92 KB
edit raw normal view history
f7563de62   Palak Handa   first commit 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
  # mime-db
  
  [![NPM Version][npm-version-image]][npm-url]
  [![NPM Downloads][npm-downloads-image]][npm-url]
  [![Node.js Version][node-image]][node-url]
  [![Build Status][travis-image]][travis-url]
  [![Coverage Status][coveralls-image]][coveralls-url]
  
  This is a database of all mime types.
  It consists of a single, public JSON file and does not include any logic,
  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
  
  ## Installation
  
  ```bash
  npm install mime-db
  ```
  
  ### Database Download
  
  If you're crazy enough to use this in the browser, you can just grab the
  JSON file using [RawGit](https://rawgit.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.
  
  ```
  https://cdn.rawgit.com/jshttp/mime-db/master/db.json
  ```
  
  ## Usage
  
  ```js
  var db = require('mime-db');
  
  // grab data on .js files
  var data = db['application/javascript'];
  ```
  
  ## Data Structure
  
  The JSON file is a map lookup for lowercased mime types.
  Each mime type has the following properties:
  
  - `.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)
  - `.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`.
  
  ## Contributing
  
  To edit the database, only make PRs against `src/custom.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.
  
  [npm-version-image]: https://img.shields.io/npm/v/mime-db.svg
  [npm-downloads-image]: https://img.shields.io/npm/dm/mime-db.svg
  [npm-url]: https://npmjs.org/package/mime-db
  [travis-image]: https://img.shields.io/travis/jshttp/mime-db/master.svg
  [travis-url]: https://travis-ci.org/jshttp/mime-db
  [coveralls-image]: https://img.shields.io/coveralls/jshttp/mime-db/master.svg
  [coveralls-url]: https://coveralls.io/r/jshttp/mime-db?branch=master
  [node-image]: https://img.shields.io/node/v/mime-db.svg
  [node-url]: http://nodejs.org/download/