Blame view

node_modules/mime-types/README.md 3.05 KB
ce4c83ff   wxy   初始提交
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
  # mime-types
  
  [![NPM Version][npm-image]][npm-url]
  [![NPM Downloads][downloads-image]][downloads-url]
  [![Node.js Version][node-version-image]][node-version-url]
  [![Build Status][travis-image]][travis-url]
  [![Test Coverage][coveralls-image]][coveralls-url]
  
  The ultimate javascript content-type utility.
  
  Similar to [the `mime@1.x` module](https://www.npmjs.com/package/mime), except:
  
  - __No fallbacks.__ Instead of naively returning the first available type,
    `mime-types` simply returns `false`, so do
    `var type = mime.lookup('unrecognized') || 'application/octet-stream'`.
  - No `new Mime()` business, so you could do `var lookup = require('mime-types').lookup`.
  - No `.define()` functionality
  - Bug fixes for `.lookup(path)`
  
  Otherwise, the API is compatible with `mime` 1.x.
  
  ## Install
  
  This is a [Node.js](https://nodejs.org/en/) module available through the
  [npm registry](https://www.npmjs.com/). Installation is done using the
  [`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
  
  ```sh
  $ npm install mime-types
  ```
  
  ## Adding Types
  
  All mime types are based on [mime-db](https://www.npmjs.com/package/mime-db),
  so open a PR there if you'd like to add mime types.
  
  ## API
  
  ```js
  var mime = require('mime-types')
  ```
  
  All functions return `false` if input is invalid or not found.
  
  ### mime.lookup(path)
  
  Lookup the content-type associated with a file.
  
  ```js
  mime.lookup('json')             // 'application/json'
  mime.lookup('.md')              // 'text/markdown'
  mime.lookup('file.html')        // 'text/html'
  mime.lookup('folder/file.js')   // 'application/javascript'
  mime.lookup('folder/.htaccess') // false
  
  mime.lookup('cats') // false
  ```
  
  ### mime.contentType(type)
  
  Create a full content-type header given a content-type or extension.
  
  ```js
  mime.contentType('markdown')  // 'text/x-markdown; charset=utf-8'
  mime.contentType('file.json') // 'application/json; charset=utf-8'
  
  // from a full path
  mime.contentType(path.extname('/path/to/file.json')) // 'application/json; charset=utf-8'
  ```
  
  ### mime.extension(type)
  
  Get the default extension for a content-type.
  
  ```js
  mime.extension('application/octet-stream') // 'bin'
  ```
  
  ### mime.charset(type)
  
  Lookup the implied default charset of a content-type.
  
  ```js
  mime.charset('text/markdown') // 'UTF-8'
  ```
  
  ### var type = mime.types[extension]
  
  A map of content-types by extension.
  
  ### [extensions...] = mime.extensions[type]
  
  A map of extensions by content-type.
  
  ## License
  
  [MIT](LICENSE)
  
  [npm-image]: https://img.shields.io/npm/v/mime-types.svg
  [npm-url]: https://npmjs.org/package/mime-types
  [node-version-image]: https://img.shields.io/node/v/mime-types.svg
  [node-version-url]: https://nodejs.org/en/download/
  [travis-image]: https://img.shields.io/travis/jshttp/mime-types/master.svg
  [travis-url]: https://travis-ci.org/jshttp/mime-types
  [coveralls-image]: https://img.shields.io/coveralls/jshttp/mime-types/master.svg
  [coveralls-url]: https://coveralls.io/r/jshttp/mime-types
  [downloads-image]: https://img.shields.io/npm/dm/mime-types.svg
  [downloads-url]: https://npmjs.org/package/mime-types