Blame view

node_modules/compressible/README.md 1.82 KB
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
  # compressible
  
  [![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]
  
  Compressible `Content-Type` / `mime` checking.
  
  ## Installation
  
  ```sh
  $ npm install compressible
  ```
  
  ## API
  
  <!-- eslint-disable no-unused-vars -->
  
  ```js
  var compressible = require('compressible')
  ```
  
  ### compressible(type)
  
  Checks if the given `Content-Type` is compressible. The `type` argument is expected
  to be a value MIME type or `Content-Type` string, though no validation is performed.
  
  The MIME is looked up in the [`mime-db`](https://www.npmjs.com/package/mime-db) and
  if there is compressible information in the database entry, that is returned. Otherwise,
  this module will fallback to `true` for the following types:
  
    * `text/*`
    * `*/*+json`
    * `*/*+text`
    * `*/*+xml`
  
  If this module is not sure if a type is specifically compressible or specifically
  uncompressible, `undefined` is returned.
  
  <!-- eslint-disable no-undef -->
  
  ```js
  compressible('text/html') // => true
  compressible('image/png') // => false
  ```
  
  ## License
  
  [MIT](LICENSE)
  
  [npm-image]: https://img.shields.io/npm/v/compressible.svg
  [npm-url]: https://npmjs.org/package/compressible
  [node-version-image]: https://img.shields.io/node/v/compressible.svg
  [node-version-url]: https://nodejs.org/en/download/
  [travis-image]: https://img.shields.io/travis/jshttp/compressible/master.svg
  [travis-url]: https://travis-ci.org/jshttp/compressible
  [coveralls-image]: https://img.shields.io/coveralls/jshttp/compressible/master.svg
  [coveralls-url]: https://coveralls.io/r/jshttp/compressible?branch=master
  [downloads-image]: https://img.shields.io/npm/dm/compressible.svg
  [downloads-url]: https://npmjs.org/package/compressible