expressjs/compression được TopGit xếp vào nhóm dự án frontend, với 2.8k sao trên GitHub, viết chủ yếu bằng JavaScript. Node.js compression middleware
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
Note Brotli is available in all currently supported Node.js LTS versions (v18+).
Install
This is a Node.js module available through the
npm registry. Installation is done using the
npm install command:
$ npm install compression
API
var compression = require('compression')
compression([options])
Returns the compression middleware using the given options. The middleware
will attempt to compress response bodies for all requests that traverse through
the middleware, based on the given options.
This middleware will never compress responses that include a Cache-Control
header with the no-transform directive,
as compressing will transform the body.
Options
compression() accepts these properties in the options object. In addition to
those listed below, zlib options may be
passed in to the options object or
brotli options.
chunkSize
Type: Number
Default: zlib.constants.Z_DEFAULT_CHUNK, or 16384.
See Node.js documentation
regarding the usage.
filter
Type: Function
A function to decide if the response should be considered for compression.
This function is called as filter(req, res) and is expected to return
true to consider the response for compression, or false to not compress
the response.
The default filter function uses the compressible
module to determine if res.getHeader('Content-Type') is compressible.
level
Type: Number
Default: zlib.constants.Z_DEFAULT_COMPRESSION, or -1
The level of zlib compression to apply to responses. A higher level will result
in better compression, but will take longer to complete. A lower level will
result in less compression, but will be much faster.
This is an integer in the range of 0 (no compression) to 9 (maximum
compression). The special value -1 can be used to mean the "default
compression level", which is a default compromise between speed and
compression (currently equivalent to level 6).
6 (currently what zlib.constants.Z_DEFAULT_COMPRESSION points to).
7
8
9 Best compression (also zlib.constants.Z_BEST_COMPRESSION).
Note in the list above, zlib is from zlib = require('zlib').
memLevel
Type: Number
Default: zlib.constants.Z_DEFAULT_MEMLEVEL, or 8
This specifies how much memory should be allocated for the internal compression
state and is an integer in the range of 1 (minimum level) and 9 (maximum
level).
See Node.js documentation
regarding the usage.
brotli
Type: Object
This specifies the options for configuring Brotli. See Node.js documentation for a complete list of available options.
strategy
Type: Number
Default: zlib.constants.Z_DEFAULT_STRATEGY
This is used to tune the compression algorithm. This value only affects the
compression ratio, not the correctness of the compressed output, even if it
is not set appropriately.
zlib.constants.Z_DEFAULT_STRATEGY Use for normal data.
zlib.constants.Z_FILTERED Use for data produced by a filter (or predictor).
Filtered data consists mostly of small values with a somewhat random
distribution. In this case, the compression algorithm is tuned to
compress them better. The effect is to force more Huffman coding and less
string matching; it is somewhat intermediate between zlib.constants.Z_DEFAULT_STRATEGY
and zlib.constants.Z_HUFFMAN_ONLY.
zlib.constants.Z_FIXED Use to prevent the use of dynamic Huffman codes, allowing
for a simpler decoder for special applications.
zlib.constants.Z_HUFFMAN_ONLY Use to force Huffman encoding only (no string match).
zlib.constants.Z_RLE Use to limit match distances to one (run-length encoding).
This is designed to be almost as fast as zlib.constants.Z_HUFFMAN_ONLY, but give
better compression for PNG image data.
Note in the list above, zlib is from zlib = require('zlib').
threshold
Type: Number or String
Default: 1kb
The byte threshold for the response body size before compression is considered
for the response. This is a number of bytes or any string
accepted by the bytes module.
Note this is only an advisory setting; if the response size cannot be determined
at the time the response headers are written, then it is assumed the response is
over the threshold. To guarantee the response size can be determined, be sure
set a Content-Length response header.
windowBits
Type: Number
Default: zlib.constants.Z_DEFAULT_WINDOWBITS, or 15
See Node.js documentation
regarding the usage.
enforceEncoding
Type: String
Default: identity
This is the default encoding to use when the client does not specify an encoding in the request's Accept-Encoding header.
.filter
The default filter function. This is used to construct a custom filter
function that is an extension of the default function.
var compression = require('compression')
var express = require('express')
var app = express()
app.use(compression({ filter: shouldCompress }))
function shouldCompress (req, res) {
if (req.headers['x-no-compression']) {
// don't compress responses with this request header
return false
}
// fallback to standard filter function
return compression.filter(req, res)
}
res.flush
This module adds a res.flush() method to force the partially-compressed
response to be flushed to the client.
Examples
express
When using this module with express, simply app.use the module as
high as you like. Requests that pass through the middleware will be compressed.
var compression = require('compression')
var express = require('express')
var app = express()
// compress all responses
app.use(compression())
// add all routes
Node.js HTTP server
var compression = require('compression')({ threshold: 0 })
var http = require('http')
function createServer (fn) {
return http.createServer(function (req, res) {
compression(req, res, function (err) {
if (err) {
res.statusCode = err.status || 500
res.end(err.message)
return
}
fn(req, res)
})
})
}
var server = createServer(function (req, res) {
res.setHeader('Content-Type', 'text/plain')
res.end('hello world!')
})
server.listen(3000, () => {
console.log('> Listening at http://localhost:3000')
})
Server-Sent Events
Because of the nature of compression this module does not work out of the box
with server-sent events. To compress content, a window of the output needs to
be buffered up in order to get good compression. Typically when using server-sent
events, there are certain block of data that need to reach the client.
You can achieve this by calling res.flush() when you need the data written to
actually make it to the client.
var compression = require('compression')
var express = require('express')
var app = express()
// compress responses
app.use(compression())
// server-sent event stream
app.get('/events', function (req, res) {
res.setHeader('Content-Type', 'text/event-stream')
res.setHeader('Cache-Control', 'no-cache')
// send a ping approx every 2 seconds
var timer = setInterval(function () {
res.write('data: ping\n\n')
// !!! this is the important part
res.flush()
}, 2000)
res.on('close', function () {
clearInterval(timer)
})
})
Contributing
The Express.js project welcomes all constructive contributions. Contributions take many forms,
from code for bug fixes and enhancements, to additions and fixes to documentation, additional
tests, triaging incoming pull requests and issues, and more!
See the Contributing Guide for more technical details on contributing.
expressjs/compression thuộc nhóm Frontend trên TopGit, cùng 7 topic GitHub. Trang Trending và Topics liệt kê các repo cùng số sao và cùng ngôn ngữ để so sánh.
Đọc thêm về expressjs/compression ở đâu?
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/expressjs/compression là nguồn chính thức.
expressjs/compression có phải mã nguồn mở không?
Có — expressjs/compression phát hành theo license MIT, nghĩa là mã nguồn mở để đọc, fork và (tùy license) tái sử dụng. Mã: github.com/expressjs/compression.
expressjs/compression có website riêng không?
TopGit chưa ghi nhận URL trang chủ cho expressjs/compression. Phần README ở tab phía trên thường có link demo, hoặc xem mô tả GitHub của repo.
expressjs/compression dùng license gì?
expressjs/compression phát hành theo license MIT. Nên mở file LICENSE trên GitHub để xác nhận — license metadata đôi khi lệch với thực tế dự án.
expressjs/compression là gì?
expressjs/compression (expressjs/compression) là dự án JavaScript trên GitHub. Theo mô tả gốc: Node.js compression middleware
Vì sao expressjs/compression được xếp vào nhóm Frontend?
TopGit xếp expressjs/compression vào nhóm Frontend dựa trên GitHub topics và mô tả của repo (gắn thẻ: "compression", "deflate", "expressjs"). Việc phân loại dựa trên metadata thật của repo, không phải đoán theo cảm tính biên tập.
Đọc đầy đủ README ở tab phía trên.
compression có đáng để bạn bỏ thời gian?
ChatGPT, Claude và Perplexity đều đọc được trang này. Hỏi thử xem họ nghĩ gì về compression.