Skip to content
This repository has been archived by the owner on Jul 16, 2020. It is now read-only.
/ kompression Public archive

This is a fork of koa-compress with support for brotli compression

License

Notifications You must be signed in to change notification settings

tuananh/kompression

Repository files navigation

Kompression

npm Build Status

This is a fork of koa-compress with support for brotli compression.

Because zlib and iltorb options doesn't have much in common so including support for brotli would be a breaking change.

I'm trimming down the available options in this package down to just filter and threshold.

Example

const compress = require('kompression')
const Koa = require('koa')

const app = new Koa()
app.use(
    compress({
        filter: function(content_type) {
            return /text/i.test(content_type)
        },
        threshold: 2048
    })
)

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)
})

About

This is a fork of koa-compress with support for brotli compression

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published