npmpackage.info

Gathering detailed insights and metrics for promise-stream-reader

Other packages similar to promise-stream-reader

strtok3

10.2.2

A promise based streaming tokenizer

@vates/stream-reader

0.1.0

Efficiently reads and skips chunks of a given size in a stream

@trenskow/stream-reader

0.2.8

A simple promise to read the content of a stream in Node.js.

read-next-line

0.5.0

Reads text lines from stream

Gathering detailed insights and metrics for promise-stream-reader

promise-stream-reader - 1.0.1 | npmpackage.info

promise-stream-reader

Consume readable streams in Node.js using promises

1.0.1

MIT

TypeScript

799.00 B

1,354,270 1.7

Installations

npm install promise-stream-reader

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>8.0.0

Node Version

8.11.1

NPM Version

5.6.0 Score

90.3

Supply Chain

93.9

Quality

75.1

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

1

Closed

0

Merged

1

Issues

Open

1

Total

1

Closed

0

Releases

v1.0.1

Updated on Apr 28, 2018

v1.0.0

Updated on Apr 28, 2018

View All 2 releases

Languages

TypeScript

TypeScript (100%)

Developer

princjef

Download Statistics

Total Downloads

1,354,270

Last Day

2,220

Last Week

12,257

Last Month

52,867

Last Year

361,430

GitHub Statistics

MIT License

2 Stars

10 Commits

1 Watchers

1 Branches

1 Contributors

Updated on May 14, 2021

Bundle Size

2.07 kB

Minified

799.00 B

Minified + Gzipped

Bundlephobia

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

1.0.1

Package Id

promise-stream-reader@1.0.1

Unpacked Size

24.18 kB

Size

8.11 kB

File Count

NPM Version

5.6.0

Node Version

8.11.1

Total Downloads

Cumulative downloads

Total Downloads

1,354,270

Last Day

61.2%

2,220

Compared to previous day

Last Week

-9.3%

12,257

Compared to previous week

Last Month

6.7%

52,867

Compared to previous month

Last Year

73.1%

361,430

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@commitlint/cli @commitlint/config-conventional @commitlint/prompt-cli @commitlint/travis-cli @types/node ava codecov husky nyc opener rimraf semantic-release tslint tslint-config-standard typescript

promise-stream-reader

Consume data from Node.js readable streams using promises and async/await to control flow.

npm install promise-stream-reader

Usage

The base export is a function that returns a writable stream to which you can pipe your readable/duplex stream.

1const promiseStream = require('promise-stream-reader');
2
3async function readStream(readableStream) {
4    const reader = promiseStream();
5    readableStream.pipe(reader);
6
7    // Read 4 bytes of data from the stream
8    const part1 = await reader.read(4);
9
10    // Skip 10 bytes of data
11    await reader.skip(10);
12
13    // You can also have multiple read/skip calls pending at the same time. They
14    // will be filled with data in the order they were initially requested.
15    const [part2, part3] = await Promise.all([
16        reader.read(6),
17        reader.read(8)
18    ]);
19
20    // When you're all done, you can close up the streams
21    readableStream.unpipe(reader);
22    reader.destroy();
23    readableStream.destroy();
24}
25
26readStream(/* some readable stream */)
27    .catch(err => { /* don't forget to handle rejected promises */ });

NOTE: If you're using Typescript, the base exported function is available under the default export.

Why?

There are two modes for reading data from a readable stream in Node.js, but each has limitations that can be frustrating for a final consumer:

on('data') (flowing) allows you to deal with data as it comes in, but you have to take care of packaging the data up into the chunks appropriate for your use case. You will also continue to receive data as fast as it comes in by default, even if you're not really ready for it.
read() (paused) allows you to explicitly request data but has no mechanism for asynchronous retrieval. As a result, it will return null if there is no data available yet, forcing you to poll until you get the data you want. You can combine this with listening to the 'readable' event, but then you're using two patterns and still have to wrap it if you want to use promises.

This solution aims to strike a balance between the two, allowing you to request the data you want when you need it and have the stream provide it to you as soon as it's available. You get to process the data quickly without extra manipulation or control flow required and can proceed at your own pace.

Contributing

Want to contribute to the project? Go check out the Contribution Guide for instructions to set up your development environment, open an issue and create a pull request.

No vulnerabilities found.

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.

0

Code-Review

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

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

Security-Policy

Determines if the project has published a security policy.

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.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

76 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-mh2h-6j8q-x246
Warn: Project is vulnerable to: GHSA-5q88-cjfq-g2mh
Warn: Project is vulnerable to: GHSA-xp63-6vf5-xf3v
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-h726-x36v-rx45
Warn: Project is vulnerable to: GHSA-779f-wgxg-qr8f
Warn: Project is vulnerable to: GHSA-xf5p-87ch-gxw2
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-r2j6-p67h-q639
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2025-05-05

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