tra-analysis/website/functions/node_modules/compressible/README.md

63 lines
1.8 KiB
Markdown
Raw Normal View History

2019-01-06 19:14:45 +00:00
# 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