koa-compress
Compress middleware for koa
Last updated 9 months ago by jongleberry .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install koa-compress 
SYNC missed versions from official npm registry.

Koa Compress

Build Status codecov Greenkeeper badge

Compress middleware for Koa

Example

var compress = require('koa-compress')
var Koa = require('koa')

var app = new Koa()
app.use(compress({
  filter: function (content_type) {
  	return /text/i.test(content_type)
  },
  threshold: 2048,
  flush: require('zlib').Z_SYNC_FLUSH
}))

Options

The options are passed to zlib: http://nodejs.org/api/zlib.html#zlib_options

filter

An optional function that checks the response content type to decide whether to compress. By default, it uses compressible.

threshold

Minimum response size in bytes to compress. Default 1024 bytes or 1kb.

Manually turning compression on and off

You can always enable compression by setting this.compress = true. You can always disable compression by setting this.compress = false. This bypasses the filter check.

app.use((ctx, next) => {
  ctx.compress = true
  ctx.body = fs.createReadStream(file)
})

Current Tags

  • 3.0.0                                ...           latest (9 months ago)
  • 2.0.0                                ...           next (3 years ago)

13 Versions

  • 3.0.0                                ...           9 months ago
  • 2.0.0                                ...           3 years ago
  • 1.0.9                                ...           3 years ago
  • 1.0.8                                ...           4 years ago
  • 1.0.7                                ...           5 years ago
  • 1.0.6                                ...           5 years ago
  • 1.0.5                                ...           5 years ago
  • 1.0.4                                ...           5 years ago
  • 1.0.3                                ...           5 years ago
  • 1.0.2                                ...           5 years ago
  • 1.0.1                                ...           5 years ago
  • 1.0.0                                ...           5 years ago
  • 0.0.1                                ...           5 years ago
Downloads
Today 92
This Week 2,457
This Month 6,837
Last Day 413
Last Week 2,667
Last Month 11,356
Dependencies (4)
Dependents (351)

Copyright 2014 - 2016 © taobao.org |