Installations

npm install @masx200/koa-stream-etag

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

16.15.1

NPM Version

8.5.1 Score

68.9

Supply Chain

99.3

Quality

75.6

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

5

Total

117

Closed

102

Merged

10

Issues

Open

0

Total

1

Closed

1

Releases

4

5.0.8

Published on 05 Jun 2022

5.0.7

Published on 13 May 2022

5.0.5

Published on 09 May 2022

5.0.1

Published on 10 Jun 2021

View all 4 releases

Contributors

14

Unable to fetch Contributors

View all 14 contributors

Languages

2

JavaScript

TypeScript

JavaScript (81.66%)

TypeScript (18.34%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

masx200

Download Statistics

Total Downloads

4,667

Last Day

3

Last Week

12

Last Month

56

Last Year

1,187

GitHub Statistics

2 Stars

153 Commits

1 Forks

1 Watching

7 Branches

14 Contributors

Bundle Size

2.13 kB

Minified

1.03 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

5.0.8

Package Id

@masx200/koa-stream-etag@5.0.8

Unpacked Size

10.44 kB

Size

4.00 kB

File Count

5

NPM Version

8.5.1

Node Version

16.15.1

Total Downloads

Cumulative downloads

Total Downloads

4,667

Last day

50%

3

Compared to previous day

Last week

-25%

12

Compared to previous week

Last month

-31.7%

56

Compared to previous month

Last year

37.9%

1,187

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

etag

Dev Dependencies

19

@types/etag @types/koa @types/mocha @types/node @types/supertest eslint eslint-config-standard eslint-plugin-import eslint-plugin-node eslint-plugin-promise eslint-plugin-standard koa mocha nyc prettier rimraf should supertest typescript

Versions

@masx200/koa-stream-etag

forked from https://github.com/koajs/etag

If the response of the koa server is a stream without a path, the response header of etag can also be generated,The etag response header is generated by converting stream to buffer for etag calculation.

stream Etag support for Koa responses using etag.

Installation

npm

1
2$ npm install @masx200/koa-stream-etag

yarn

$ yarn add @masx200/koa-stream-etag

API

1var etag = require("@masx200/koa-stream-etag");

`etag([options])`

Its return value is a koa middleware.

Generate a strong ETag for the given entity. This should be the complete body of the entity. Strings, Buffers, and fs.Stats are accepted. By default, a strong ETag is generated except for fs.Stats, which will generate a weak ETag (this can be overwritten by options.weak).

1var options = { weak: false, sizelimit: 1000 * 1024 };
2app.use(etag(options));

Options

etag accepts these properties in the options object.

`weak`

Specifies if the generated ETag will include the weak validator mark (that is, the leading W/). The actual entity tag is the same. The default value is false, unless the entity is fs.Stats, in which case it is true.

`sizelimit`

Its unit is byte.If the size of the stream is smaller than the'sizelimit', the etag response header will be generated,by converting stream to buffer for etag calculation.

Example

1const conditional = require("koa-conditional-get");
2const etag = require("@masx200/koa-stream-etag");
3const Koa = require("koa");
4const app = new Koa();
5
6// etag works together with conditional-get
7app.use(conditional());
8app.use(etag({}));
9
10app.use(function (ctx) {
11    ctx.body = "Hello World";
12});
13
14app.listen(3000, () => {
15    console.log("listening on port 3000");
16});

License

MIT

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

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

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

Code-Review

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

0

Pinned-Dependencies

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

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.4

/10

Last Scanned on 2025-01-27

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