http-compression
Version:
Adding gzip/brotli for your HTTP server
107 lines (69 loc) • 3.33 kB
Markdown
[](https://coveralls.io/github/Kikobeats/http-compression)
[](https://www.npmjs.org/package/http-compression)
**http-compression** adds compression for your HTTP server in Node.js by:
- No dependencies (< 1kB).
- Express style middleware support.
- Auto detect the best encoding to use (gzip/brotli).
## Install
```bash
$ npm install http-compression --save
```
## Usage
If you are using an Express style framework, you can add it as middlware:
```js
const compression = require('http-compression')
const express = require('express')
express()
.use(compression({ /* see options below */ }))
.use((req, res) => {
// this will get compressed:
res.end('hello world!'.repeat(1000))
})
.listen(3000)
```
Otherwise, just pass `req, res` primitives to it:
```js
const compression = require('http-compression')({ /* see options below */ })
const { createServer } = require('http')
const server = createServer((req, res) => {
compression(req, res)
res.end('hello world!'.repeat(1000))
})
server.listen(3000, () => {
console.log('> Listening at http://localhost:3000')
})
```
The `compression(options)` function returns an Express style middleware of the form `(req, res, next)`.
Type: `Number`<br>
Default: `1024`
Responses below this threshold (in bytes) are not compressed. The default value of `1024` is recommended, and avoids sharply diminishing compression returns.
#### level
Type: `object`<br>
Default: `{ brotli: 1, gzip: 1 }`
The compression effort/level/quality setting, used by both Gzip and Brotli. The scale range is:
- brotli: from 0 to 11.
- gzip: from -1 to 9.
The library uses uses the most efficiency level by default determined by a [benchmark](bencharmk/index.mjs).
Type: `boolean`<br>
Default: `true`
Enables response compression using Brotli for requests that support it. as determined by the `Accept-Encoding` request header.
Type: `boolean`<br>
Default: `true`
Enables response compression using Gzip for requests that support it, as determined by the `Accept-Encoding` request header.
Type: `RegExp`<br>
Default: `/text|javascript|\/json|xml/i`
The `Content-Type` response header is evaluated against this Regular Expression to determine if it is a MIME type that should be compressed.
Remember that compression is generally only effective on textual content.
Thanks to [developit](https://github.com/developit) for written the original code implementation for [polka#148](https://github.com/lukeed/polka/pull/148).
**http-compression** © [Kiko Beats](https://kikobeats.com), released under the [MIT](https://github.com/Kikobeats/http-compression/blob/master/LICENSE.md) License.<br>
Authored and maintained by [Kiko Beats](https://kikobeats.com) with help from [contributors](https://github.com/Kikobeats/http-compression/contributors).
> [kikobeats.com](https://kikobeats.com) · GitHub [Kiko Beats](https://github.com/Kikobeats) · X [@Kikobeats](https://x.com/Kikobeats)