134 lines
10 KiB
JSON
134 lines
10 KiB
JSON
{
|
|
"_args": [
|
|
[
|
|
{
|
|
"raw": "compression@~1.5.2",
|
|
"scope": null,
|
|
"escapedName": "compression",
|
|
"name": "compression",
|
|
"rawSpec": "~1.5.2",
|
|
"spec": ">=1.5.2 <1.6.0",
|
|
"type": "range"
|
|
},
|
|
"/home/jdaugherty/work/GT2/GT2-Android/node_modules/connect"
|
|
]
|
|
],
|
|
"_from": "compression@>=1.5.2 <1.6.0",
|
|
"_id": "compression@1.5.2",
|
|
"_inCache": true,
|
|
"_location": "/compression",
|
|
"_npmUser": {
|
|
"name": "dougwilson",
|
|
"email": "doug@somethingdoug.com"
|
|
},
|
|
"_npmVersion": "1.4.28",
|
|
"_phantomChildren": {
|
|
"mime-types": "2.1.17"
|
|
},
|
|
"_requested": {
|
|
"raw": "compression@~1.5.2",
|
|
"scope": null,
|
|
"escapedName": "compression",
|
|
"name": "compression",
|
|
"rawSpec": "~1.5.2",
|
|
"spec": ">=1.5.2 <1.6.0",
|
|
"type": "range"
|
|
},
|
|
"_requiredBy": [
|
|
"/connect"
|
|
],
|
|
"_resolved": "https://registry.npmjs.org/compression/-/compression-1.5.2.tgz",
|
|
"_shasum": "b03b8d86e6f8ad29683cba8df91ddc6ffc77b395",
|
|
"_shrinkwrap": null,
|
|
"_spec": "compression@~1.5.2",
|
|
"_where": "/home/jdaugherty/work/GT2/GT2-Android/node_modules/connect",
|
|
"bugs": {
|
|
"url": "https://github.com/expressjs/compression/issues"
|
|
},
|
|
"contributors": [
|
|
{
|
|
"name": "Douglas Christopher Wilson",
|
|
"email": "doug@somethingdoug.com"
|
|
},
|
|
{
|
|
"name": "Jonathan Ong",
|
|
"email": "me@jongleberry.com",
|
|
"url": "http://jongleberry.com"
|
|
}
|
|
],
|
|
"dependencies": {
|
|
"accepts": "~1.2.12",
|
|
"bytes": "2.1.0",
|
|
"compressible": "~2.0.5",
|
|
"debug": "~2.2.0",
|
|
"on-headers": "~1.0.0",
|
|
"vary": "~1.0.1"
|
|
},
|
|
"description": "Node.js compression middleware",
|
|
"devDependencies": {
|
|
"istanbul": "0.3.17",
|
|
"mocha": "2.2.5",
|
|
"supertest": "1.0.1"
|
|
},
|
|
"directories": {},
|
|
"dist": {
|
|
"shasum": "b03b8d86e6f8ad29683cba8df91ddc6ffc77b395",
|
|
"tarball": "https://registry.npmjs.org/compression/-/compression-1.5.2.tgz"
|
|
},
|
|
"engines": {
|
|
"node": ">= 0.8.0"
|
|
},
|
|
"files": [
|
|
"LICENSE",
|
|
"HISTORY.md",
|
|
"index.js"
|
|
],
|
|
"gitHead": "c2af8bd8d5cec3577b40d61859ca3a0467052ded",
|
|
"homepage": "https://github.com/expressjs/compression#readme",
|
|
"license": "MIT",
|
|
"maintainers": [
|
|
{
|
|
"name": "jongleberry",
|
|
"email": "jonathanrichardong@gmail.com"
|
|
},
|
|
{
|
|
"name": "federomero",
|
|
"email": "federomero@gmail.com"
|
|
},
|
|
{
|
|
"name": "dougwilson",
|
|
"email": "doug@somethingdoug.com"
|
|
},
|
|
{
|
|
"name": "fishrock123",
|
|
"email": "fishrock123@rocketmail.com"
|
|
},
|
|
{
|
|
"name": "tjholowaychuk",
|
|
"email": "tj@vision-media.ca"
|
|
},
|
|
{
|
|
"name": "mscdex",
|
|
"email": "mscdex@mscdex.net"
|
|
},
|
|
{
|
|
"name": "defunctzombie",
|
|
"email": "shtylman@gmail.com"
|
|
}
|
|
],
|
|
"name": "compression",
|
|
"optionalDependencies": {},
|
|
"readme": "# compression\n\n[![NPM Version][npm-image]][npm-url]\n[![NPM Downloads][downloads-image]][downloads-url]\n[![Build Status][travis-image]][travis-url]\n[![Test Coverage][coveralls-image]][coveralls-url]\n[![Gratipay][gratipay-image]][gratipay-url]\n\nNode.js compression middleware.\n\nThe following compression codings are supported:\n\n - deflate\n - gzip\n\n## Install\n\n```bash\n$ npm install compression\n```\n\n## API\n\n```js\nvar compression = require('compression')\n```\n\n### compression([options])\n\nReturns the compression middleware using the given `options`.\n\n#### Options\n\n`compression()` accepts these properties in the options object. In addition to\nthose listed below, [zlib](http://nodejs.org/api/zlib.html) options may be\npassed in to the options object.\n\n##### chunkSize\n\nThe default value is `zlib.Z_DEFAULT_CHUNK`, or `16384`.\n\nSee [Node.js documentation](http://nodejs.org/api/zlib.html#zlib_memory_usage_tuning)\nregarding the usage.\n\n##### filter\n\nA function to decide if the response should be considered for compression.\nThis function is called as `filter(req, res)` and is expected to return\n`true` to consider the response for compression, or `false` to not compress\nthe response.\n\nThe default filter function uses the [compressible](https://www.npmjs.com/package/compressible)\nmodule to determine if `res.getHeader('Content-Type')` is compressible.\n\n##### level\n\nThe level of zlib compression to apply to responses. A higher level will result\nin better compression, but will take longer to complete. A lower level will\nresult in less compression, but will be much faster.\n\nThis is an integer in the range of `0` (no compression) to `9` (maximum\ncompression). The special value `-1` can be used to mean the \"default\ncompression level\", which is a default compromise between speed and\ncompression (currently equivalent to level 6).\n\n - `-1` Default compression level (also `zlib.Z_DEFAULT_COMPRESSION`).\n - `0` No compression (also `zlib.Z_NO_COMPRESSION`).\n - `1` Fastest compression (also `zlib.Z_BEST_SPEED`).\n - `2`\n - `3`\n - `4`\n - `5`\n - `6` (currently what `zlib.Z_DEFAULT_COMPRESSION` points to).\n - `7`\n - `8`\n - `9` Best compression (also `zlib.Z_BEST_COMPRESSION`).\n\nThe default value is `zlib.Z_DEFAULT_COMPRESSION`, or `-1`.\n\n**Note** in the list above, `zlib` is from `zlib = require('zlib')`.\n\n##### memLevel\n\nThis specifies how much memory should be allocated for the internal compression\nstate and is an integer in the range of `1` (minimum level) and `9` (maximum\nlevel).\n\nThe default value is `zlib.Z_DEFAULT_MEMLEVEL`, or `8`.\n\nSee [Node.js documentation](http://nodejs.org/api/zlib.html#zlib_memory_usage_tuning)\nregarding the usage.\n\n##### strategy\n\nThis is used to tune the compression algorithm. This value only affects the\ncompression ratio, not the correctness of the compressed output, even if it\nis not set appropriately.\n\n - `zlib.Z_DEFAULT_STRATEGY` Use for normal data.\n - `zlib.Z_FILTERED` Use for data produced by a filter (or predictor).\n Filtered data consists mostly of small values with a somewhat random\n distribution. In this case, the compression algorithm is tuned to\n compress them better. The effect is to force more Huffman coding and less\n string matching; it is somewhat intermediate between `zlib.Z_DEFAULT_STRATEGY`\n and `zlib.Z_HUFFMAN_ONLY`.\n - `zlib.Z_FIXED` Use to prevent the use of dynamic Huffman codes, allowing\n for a simpler decoder for special applications.\n - `zlib.Z_HUFFMAN_ONLY` Use to force Huffman encoding only (no string match).\n - `zlib.Z_RLE` Use to limit match distances to one (run-length encoding).\n This is designed to be almost as fast as `zlib.Z_HUFFMAN_ONLY`, but give\n better compression for PNG image data.\n\n**Note** in the list above, `zlib` is from `zlib = require('zlib')`.\n\n##### threshold\n\nThe byte threshold for the response body size before compression is considered\nfor the response, defaults to `1kb`. This is a number of bytes, any string\naccepted by the [bytes](https://www.npmjs.com/package/bytes) module, or `false`.\n\n**Note** this is only an advisory setting; if the response size cannot be determined\nat the time the response headers are written, then it is assumed the response is\n_over_ the threshold. To guarantee the response size can be determined, be sure\nset a `Content-Length` response header.\n\n##### windowBits\n\nThe default value is `zlib.Z_DEFAULT_WINDOWBITS`, or `15`.\n\nSee [Node.js documentation](http://nodejs.org/api/zlib.html#zlib_memory_usage_tuning)\nregarding the usage.\n\n#### .filter\n\nThe default `filter` function. This is used to construct a custom filter\nfunction that is an extension of the default function.\n\n```js\napp.use(compression({filter: shouldCompress}))\n\nfunction shouldCompress(req, res) {\n if (req.headers['x-no-compression']) {\n // don't compress responses with this request header\n return false\n }\n\n // fallback to standard filter function\n return compression.filter(req, res)\n}\n```\n\n### res.flush\n\nThis module adds a `res.flush()` method to force the partially-compressed\nresponse to be flushed to the client.\n\n## Examples\n\n### express/connect\n\nWhen using this module with express or connect, simply `app.use` the module as\nhigh as you like. Requests that pass through the middleware will be compressed.\n\n```js\nvar compression = require('compression')\nvar express = require('express')\n\nvar app = express()\n\n// compress all requests\napp.use(compression())\n\n// add all routes\n```\n\n### Server-Sent Events\n\nBecause of the nature of compression this module does not work out of the box\nwith server-sent events. To compress content, a window of the output needs to\nbe buffered up in order to get good compression. Typically when using server-sent\nevents, there are certain block of data that need to reach the client.\n\nYou can achieve this by calling `res.flush()` when you need the data written to\nactually make it to the client.\n\n```js\nvar compression = require('compression')\nvar express = require('express')\n\nvar app = express()\n\n// compress responses\napp.use(compression())\n\n// server-sent event stream\napp.get('/events', function (req, res) {\n res.setHeader('Content-Type', 'text/event-stream')\n res.setHeader('Cache-Control', 'no-cache')\n\n // send a ping approx every 2 seconds\n var timer = setInterval(function () {\n res.write('data: ping\\n\\n')\n\n // !!! this is the important part\n res.flush()\n }, 2000)\n\n res.on('close', function () {\n clearInterval(timer)\n })\n})\n```\n\n## License\n\n[MIT](LICENSE)\n\n[npm-image]: https://img.shields.io/npm/v/compression.svg\n[npm-url]: https://npmjs.org/package/compression\n[travis-image]: https://img.shields.io/travis/expressjs/compression/master.svg\n[travis-url]: https://travis-ci.org/expressjs/compression\n[coveralls-image]: https://img.shields.io/coveralls/expressjs/compression/master.svg\n[coveralls-url]: https://coveralls.io/r/expressjs/compression?branch=master\n[downloads-image]: https://img.shields.io/npm/dm/compression.svg\n[downloads-url]: https://npmjs.org/package/compression\n[gratipay-image]: https://img.shields.io/gratipay/dougwilson.svg\n[gratipay-url]: https://www.gratipay.com/dougwilson/\n",
|
|
"readmeFilename": "README.md",
|
|
"repository": {
|
|
"type": "git",
|
|
"url": "git+https://github.com/expressjs/compression.git"
|
|
},
|
|
"scripts": {
|
|
"test": "mocha --check-leaks --reporter spec --bail",
|
|
"test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --check-leaks --reporter dot",
|
|
"test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --check-leaks --reporter spec"
|
|
},
|
|
"version": "1.5.2"
|
|
}
|