https://github.com/koajs/compress
Compress middleware for koa
https://github.com/koajs/compress
Last synced: 27 days ago
JSON representation
Compress middleware for koa
- Host: GitHub
- URL: https://github.com/koajs/compress
- Owner: koajs
- License: mit
- Created: 2013-08-20T08:29:58.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-04-07T09:50:28.000Z (about 1 month ago)
- Last Synced: 2025-04-11T16:23:23.116Z (29 days ago)
- Language: JavaScript
- Size: 1.1 MB
- Stars: 440
- Watchers: 11
- Forks: 37
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
- awesome-koa - compress - Compress middleware for koa (Middleware)
- awesome-koa - koa-compress - 用于压缩的中间件。   (仓库 / 中间件)
README
# Koa Compress
[](https://github.com/koajs/compress/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster)
[](https://codecov.io/gh/koajs/compress)
Compress middleware for Koa
## Example
```js
const compress = require('koa-compress')
const Koa = require('koa')
const app = new Koa()
app.use(compress({
filter (content_type) {
return /text/i.test(content_type)
},
threshold: 2048,
gzip: {
flush: require('zlib').constants.Z_SYNC_FLUSH
},
deflate: {
flush: require('zlib').constants.Z_SYNC_FLUSH,
},
br: false // disable brotli
}))
```
## Maintainers
- Lead: @jonathanong [@jongleberry](https://twitter.com/jongleberry)
- Team: @koajs/compress
## Options
### filter\
```ts
function (mimeType: string): Boolean {
}
```
An optional function that checks the response content type to decide whether to compress.
By default, it uses [compressible](https://github.com/jshttp/compressible).
### options.threshold\
Minimum response size in bytes to compress.
Default `1024` bytes or `1kb`.
### options[encoding]\
The current encodings are, in order of preference: `br`, `gzip`, `deflate`.
Setting `options[encoding] = {}` will pass those options to the encoding function.
Setting `options[encoding] = false` will disable that encoding.
#### options.br
[Brotli compression](https://en.wikipedia.org/wiki/Brotli) is supported in node v11.7.0+, which includes it natively.
As of v5.1.0, the default quality level is 4 for performance reasons.
### options.defaultEncoding\
An optional string, which specifies what encoders to use for requests without
[Accept-Encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding).
Default `identity`.
The standard dictates to treat such requests as `*` meaning that all compressions are permissible,
yet it causes very practical problems when debugging servers with manual tools like `curl`, `wget`, and so on.
If you want to enable the standard behavior, just set `defaultEncoding` to `*`.
## Manually turning compression on and off
You can always enable compression by setting `ctx.compress = true`.
You can always disable compression by setting `ctx.compress = false`.
This bypasses the filter check.
```js
app.use((ctx, next) => {
ctx.compress = true
ctx.body = fs.createReadStream(file)
})
```