koa-compress

v5.0.1

Compress middleware for koa

NPM

README

GitHub

Website

MIT

Latest version published 10 months ago

    npm install koa-compress

We couldn't find any similar packages Browse all packages

Package Health Score

72 / 100

Popularity
Popular
Maintenance
Sustainable
Security
No known security issues
Community
Sustainable

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Popular

Weekly Downloads (207,489)

Dependents: 590
GitHub Stars: 386
Forks: 32
Contributors: 20

The npm package koa-compress receives a total of 207,489 downloads a week. As such, we scored koa-compress popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package koa-compress, we found that it has been starred 386 times, and that 590 other projects in the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

1.0.9

2.0.0

3.1.0

4.0.1

5.0.1

Indirect Vulnerabilities

1.0.9

2.0.0

3.1.0

4.0.1

5.0.1

License Risks

1.0.9

2.0.0

3.1.0

4.0.1

5.0.1

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like koa-compress is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

    # Install the Snyk CLI and test your project
npm i snyk -g && snyk test koa-compress

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 6
Open PR: 3
Last Release: 10 months ago
Last Commit: 8 months ago

Further analysis of the maintenance status of koa-compress based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that koa-compress demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the koa-compress repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like koa-compress is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: >= 8.0.0

Age: 8 years
Dependencies: 5 Direct
Versions: 20
Install Size: 11.8 kB
Dist-tags: 2
# of Files: 6
Maintainers: 10
TS Typings: Yes

koa-compress has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Koa Compress

Compress middleware for Koa

Example

const compress = require('koa-compress')
const Koa = require('koa')

const app = new Koa()
app.use(compress({
  filter (content_type) {
  	return /text/i.test(content_type)
  },
  threshold: 2048,
  gzip: {
    flush: require('zlib').constants.Z_SYNC_FLUSH
  },
  deflate: {
    flush: require('zlib').constants.Z_SYNC_FLUSH,
  },
  br: false // disable brotli
}))

Options

filter<Function>

function (mimeType: string): Boolean {

}

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.

options.defaultEncoding<String>

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

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.

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

koa-compress versions

Dist-Tags for koa-compress

latest next

Version	Published	Tag	Node.js Compatability	Licenses	Dependencies	Direct Vulnerabilities	Publisher
5.0.1	06 July 2020	latest	>= 8.0.0	MIT	5	0 H 0 M 0 L	niftylettuce
4.0.1	30 April 2020		>= 8.0.0	MIT	5	0 H 0 M 0 L	jongleberry
3.1.0	16 April 2020		>= 8.0.0	MIT	4	0 H 0 M 0 L	jongleberry
All Versions

Last updated on 18 April-2021, at 10:53 (UTC).

koa-compress

Compress middleware for koa

Package Health Score

Popularity

Weekly Downloads (207,489)

Security

Security and license risk for significant versions

Version

Release Date

Direct Vulnerabilities

Indirect Vulnerabilities

License Risks

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Package

Koa Compress

Example

Options

filter<Function>

options.threshold<String|Number>

options[encoding]<Object>

options.br

options.defaultEncoding<String>

Manually turning compression on and off

koa-compress versions

koa-compress dependencies

What is koa-compress?

Is koa-compress popular?

Is koa-compress safe to use?

Is koa-compress well maintained?