3 [![NPM Version][npm-version-image]][npm-url]
4 [![NPM Downloads][npm-downloads-image]][npm-url]
5 [![Node.js Version][node-version-image]][node-version-url]
6 [![Build Status][travis-image]][travis-url]
7 [![Test Coverage][coveralls-image]][coveralls-url]
9 The ultimate javascript content-type utility.
11 Similar to [the `mime@1.x` module](https://www.npmjs.com/package/mime), except:
13 - __No fallbacks.__ Instead of naively returning the first available type,
14 `mime-types` simply returns `false`, so do
15 `var type = mime.lookup('unrecognized') || 'application/octet-stream'`.
16 - No `new Mime()` business, so you could do `var lookup = require('mime-types').lookup`.
17 - No `.define()` functionality
18 - Bug fixes for `.lookup(path)`
20 Otherwise, the API is compatible with `mime` 1.x.
24 This is a [Node.js](https://nodejs.org/en/) module available through the
25 [npm registry](https://www.npmjs.com/). Installation is done using the
26 [`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
29 $ npm install mime-types
34 All mime types are based on [mime-db](https://www.npmjs.com/package/mime-db),
35 so open a PR there if you'd like to add mime types.
40 var mime = require('mime-types')
43 All functions return `false` if input is invalid or not found.
47 Lookup the content-type associated with a file.
50 mime.lookup('json') // 'application/json'
51 mime.lookup('.md') // 'text/markdown'
52 mime.lookup('file.html') // 'text/html'
53 mime.lookup('folder/file.js') // 'application/javascript'
54 mime.lookup('folder/.htaccess') // false
56 mime.lookup('cats') // false
59 ### mime.contentType(type)
61 Create a full content-type header given a content-type or extension.
62 When given an extension, `mime.lookup` is used to get the matching
63 content-type, otherwise the given content-type is used. Then if the
64 content-type does not already have a `charset` parameter, `mime.charset`
65 is used to get the default charset and add to the returned content-type.
68 mime.contentType('markdown') // 'text/x-markdown; charset=utf-8'
69 mime.contentType('file.json') // 'application/json; charset=utf-8'
70 mime.contentType('text/html') // 'text/html; charset=utf-8'
71 mime.contentType('text/html; charset=iso-8859-1') // 'text/html; charset=iso-8859-1'
74 mime.contentType(path.extname('/path/to/file.json')) // 'application/json; charset=utf-8'
77 ### mime.extension(type)
79 Get the default extension for a content-type.
82 mime.extension('application/octet-stream') // 'bin'
85 ### mime.charset(type)
87 Lookup the implied default charset of a content-type.
90 mime.charset('text/markdown') // 'UTF-8'
93 ### var type = mime.types[extension]
95 A map of content-types by extension.
97 ### [extensions...] = mime.extensions[type]
99 A map of extensions by content-type.
105 [coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/mime-types/master
106 [coveralls-url]: https://coveralls.io/r/jshttp/mime-types?branch=master
107 [node-version-image]: https://badgen.net/npm/node/mime-types
108 [node-version-url]: https://nodejs.org/en/download
109 [npm-downloads-image]: https://badgen.net/npm/dm/mime-types
110 [npm-url]: https://npmjs.org/package/mime-types
111 [npm-version-image]: https://badgen.net/npm/v/mime-types
112 [travis-image]: https://badgen.net/travis/jshttp/mime-types/master
113 [travis-url]: https://travis-ci.org/jshttp/mime-types