npmpackage.info

Gathering detailed insights and metrics for koa-compress

Other packages similar to koa-compress

@types/koa-compress

4.0.6

TypeScript definitions for koa-compress

compress-commons

7.0.0

a library that defines a common interface for working with archive formats within node

koa

2.15.3

Koa web app framework

koa-convert

2.0.0

convert modern Koa legacy generator-based middleware to promise-based middleware

Gathering detailed insights and metrics for koa-compress

koa-compress

Compress middleware for koa

5.1.1

437

MIT

JavaScript

26.36 kB

79,205,506 3.9

Installations

npm install koa-compress

Pull Requests

Open

6

Total

185

Closed

89

Merged

90

Issues

Open

1

Total

42

Closed

41

Releases

v5.1.1: fix brotli options

v5.1.1

Published on 09 Apr 2023

v5.1.0: lower brotli defaults to 4

v5.1.0

Published on 18 Aug 2021

v5.0.1

Published on 06 Jul 2020

v5.0.0

Published on 06 Jul 2020

4.0.1

Published on 30 Apr 2020

v4.0.0

Published on 28 Apr 2020

View all 7 releases

Developer

koajs

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>= 12

Typescript Support

No

Node Version

16.19.0

NPM Version

8.19.3 Statistics

437 Stars

180 Commits

36 Forks

10 Watching

7 Branches

28 Contributors

Updated on 18 Nov 2024

Bundle Size

162.70 kB

Minified

26.36 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

79,205,506

Last day

-16.4%

60,780

Compared to previous day

Last week

-2.2%

356,049

Compared to previous week

Last month

10.4%

1,537,715

Compared to previous month

Last year

-17.6%

16,208,721

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

bytes compressible http-errors koa-is-json

Dev Dependencies

eslint eslint-config-standard eslint-plugin-import eslint-plugin-node eslint-plugin-promise eslint-plugin-standard jest koa supertest

Versions

Koa Compress

Compress middleware for Koa

Example

1const compress = require('koa-compress')
2const Koa = require('koa')
3
4const app = new Koa()
5app.use(compress({
6  filter (content_type) {
7  	return /text/i.test(content_type)
8  },
9  threshold: 2048,
10  gzip: {
11    flush: require('zlib').constants.Z_SYNC_FLUSH
12  },
13  deflate: {
14    flush: require('zlib').constants.Z_SYNC_FLUSH,
15  },
16  br: false // disable brotli
17}))

Maintainers

Lead: @jonathanong @jongleberry
Team: @koajs/compress

Options

filter<Function>

1function (mimeType: string): Boolean {
2
3}

An optional function that checks the response content type to decide whether to compress. By default, it uses compressible.

options.threshold<String|Number>

Minimum response size in bytes to compress. Default 1024 bytes or 1kb.

options[encoding]<Object>

The current encodings are, in order of preference: br, gzip, deflate. Setting options[encoding] = {} will pass those options to the encoding function. Setting options[encoding] = false will disable that encoding.

options.br

Brotli compression is supported in node v11.7.0+, which includes it natively. As of v5.1.0, the default quality level is 4 for performance reasons.

options.defaultEncoding<String>

An optional string, which specifies what encoders to use for requests without Accept-Encoding. Default identity.

The standard dictates to treat such requests as * meaning that all compressions are permissible, yet it causes very practical problems when debugging servers with manual tools like curl, wget, and so on. If you want to enable the standard behavior, just set defaultEncoding to *.

Manually turning compression on and off

You can always enable compression by setting ctx.compress = true. You can always disable compression by setting ctx.compress = false. This bypasses the filter check.

1app.use((ctx, next) => {
2  ctx.compress = true
3  ctx.body = fs.createReadStream(file)
4})

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.9

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More