npmpackage.info

Gathering detailed insights and metrics for @alexssmusica/peek-readable

@alexssmusica/peek-readable - 5.0.0 | npmpackage.info

@alexssmusica/peek-readable

A promise based asynchronous stream reader, which makes reading from a stream easy.

5.0.0

MIT

TypeScript

15.86 kB

373 5

Installations

npm install @alexssmusica/peek-readable

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>=14.16

Node Version

14.19.3

NPM Version

6.14.17 Score

70.1

Supply Chain

97.7

Quality

75.2

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

3

Total

797

Closed

397

Merged

397

Issues

Open

0

Total

21

Closed

21

Releases

v7.0.0

Updated on Mar 09, 2025

v6.1.1

Updated on Feb 05, 2025

v6.1.0

Updated on Jan 31, 2025

v6.0.2

Updated on Jan 30, 2025

v6.0.1

Updated on Jan 29, 2025

v5.4.2

Updated on Jan 29, 2025

View All 53 releases

Languages

TypeScript

TypeScript (100%)

Developer

Borewit

Download Statistics

Total Downloads

373

Last Day

Last Week

Last Month

Last Year

194

GitHub Statistics

MIT License

8 Stars

887 Commits

7 Forks

2 Watchers

8 Branches

3 Contributors

Updated on May 07, 2025

Sponsor this package

https://github.com/sponsors/Borewit

Maintainers

View All 3 Contributors

Package Meta Information

Latest Version

5.0.0

Package Id

@alexssmusica/peek-readable@5.0.0

Unpacked Size

15.86 kB

Size

4.92 kB

File Count

NPM Version

6.14.17

Node Version

14.19.3

Published on

Jul 24, 2023

Total Downloads

Cumulative downloads

Total Downloads

373

Last Day

Compared to previous day

Last Week

133.3%

Compared to previous week

Last Month

-66.7%

Compared to previous month

Last Year

8.4%

194

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

peek-readable

A promise based asynchronous stream reader, which makes reading from a stream easy.

Allows to read and peek from a Readable Stream

Note that peek-readable was formally released as then-read-stream.

Usage

Installation

1npm install --save peek-readable

The peek-readable contains one class: StreamReader, which reads from a stream.Readable.

Compatibility

Module: version 5 migrated from CommonJS to pure ECMAScript Module (ESM). JavaScript is compliant with ECMAScript 2019 (ES10). Requires Node.js ≥ 14.16 engine.

Examples

In the following example we read the first 16 bytes from a stream and store them in our buffer. Source code of examples can be found here.

1import fs from 'node:fs';
2import { StreamReader } from 'peek-readable';
3
4(async () => {
5  const readable = fs.createReadStream('JPEG_example_JPG_RIP_001.jpg');
6  const streamReader = new StreamReader(readable);
7  const uint8Array = new Uint8Array(16);
8  const bytesRead = await streamReader.read(uint8Array, 0, 16);;
9  // buffer contains 16 bytes, if the end-of-stream has not been reached
10})();

End-of-stream detection:

1(async () => {
2
3  const fileReadStream = fs.createReadStream('JPEG_example_JPG_RIP_001.jpg');
4  const streamReader = new StreamReader(fileReadStream);
5  const buffer = Buffer.alloc(16); // or use: new Uint8Array(16);
6
7  try {
8    await streamReader.read(buffer, 0, 16);
9    // buffer contains 16 bytes, if the end-of-stream has not been reached
10  } catch(error) {
11    if (error instanceof EndOfStreamError) {
12      console.log('End-of-stream reached');
13    }
14  }
15})();

With peek you can read ahead:

1import fs from 'node:fs';
2import { StreamReader } from 'peek-readable';
3
4const fileReadStream = fs.createReadStream('JPEG_example_JPG_RIP_001.jpg');
5const streamReader = new StreamReader(fileReadStream);
6const buffer = Buffer.alloc(20);
7
8(async () => {
9  let bytesRead = await streamReader.peek(buffer, 0, 3);
10  if (bytesRead === 3 && buffer[0] === 0xFF && buffer[1] === 0xD8 && buffer[2] === 0xFF) {
11    console.log('This is a JPEG file');
12  } else {
13    throw Error('Expected a JPEG file');
14  }
15
16  bytesRead = await streamReader.read(buffer, 0, 20); // Read JPEG header
17  if (bytesRead === 20) {
18    console.log('Got the JPEG header');
19  } else {
20    throw Error('Failed to read JPEG header');
21  }
22})();

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

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

SAST

Determines if the project uses static code analysis.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

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.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:77: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:106: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:109: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:120: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:134: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/post-dependabot-prs.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/post-dependabot-prs.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/post-dependabot-prs.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/post-dependabot-prs.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/post-dependabot-prs.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/post-dependabot-prs.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-drafter.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/release-drafter.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-license.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/Borewit/peek-readable/update-license.yml/master?enable=pin
Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 7 third-party GitHubAction dependencies pinned

0

Token-Permissions

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

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

Branch-Protection

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

0

Security-Policy

Determines if the project has published a security policy.

Score

5

/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

@alexssmusica/peek-readable

Installations

Developer Guide

Yes

ESM

>=14.16

14.19.3

6.14.17

Score

Pull Requests

3

797

397

397

Issues

0

21

21

Releases

Languages

Developer

Borewit

Download Statistics

GitHub Statistics

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

373

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

peek-readable

Usage

Installation

Compatibility

Examples

10

10

10

10

10

10

0

0

0

0

0

0

0

5

/10