The compression(options) function returns an Express style middleware of the form (req, res, next).
Options
threshold
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.
level
Type: object
Default: { brotli: 2, gzip: 2 }
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 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:
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.
License
Thanks to developit for written the original code implementation for polka#148.