package
Add gzip, deflate, and Brotli compression middleware to Node.js HTTP servers.
npm install http-compressionGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 1 packages.
11.7 kB
Includes dependencies.
http-compression adds compression for your HTTP server in Node.js by:
$ npm install http-compression --saveIf you are using an Express style framework, you can add it as middlware:
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:
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
Default: 1024
Responses below this threshold (in bytes) are not compressed. The default value of 1024 is recommended, and avoids sharply diminishing compression returns.
Type: object
Default: { brotli: 2, gzip: 2 }
The compression effort/level/quality setting, used by both Gzip and Brotli. The scale range is:
The defaults are the highest levels that stay within 3% (plus 0.05ms of timer noise) of the fastest level on every payload tried. The benchmark serves each payload through this middleware and adds the time to send the compressed body at 100 Mbps. The payloads were HTML (794kB), Markdown (190kB), JavaScript (546kB), a JSON API response (4.2MB) and a small JSON one (2kB). Brotli 2 and gzip 2 were picked in 6 of 7 runs. Brotli 3 sits at the edge of run-to-run noise on the large JSON, 2.9% to 4.2% slower than brotli 2. Over a faster link the cheapest levels win, and over a slower one higher levels do. A level you leave out keeps its default.
Pick levels for your own traffic with the benchmark:
node benchmark/index.mjs --mbps=100 https://example.com/page.html https://example.com/api.jsonType: boolean
Default: true
Enables response compression using Brotli for requests that support it. as determined by the Accept-Encoding request header.
Type: boolean
Default: true
Enables response compression using Gzip for requests that support it, as determined by the Accept-Encoding request header.
Type: RegExp
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 for written the original code implementation for polka#148.
http-compression © Kiko Beats, released under the MIT License.
Authored and maintained by Kiko Beats with help from contributors.
kikobeats.com · GitHub Kiko Beats · X @Kikobeats