npmpackage.info

Gathering detailed insights and metrics for peek-readable

Other packages similar to peek-readable

@caoer/peek-readable

5.0.1

Read and peek from a readable stream

@alexssmusica/peek-readable

5.0.0

Read and peek from a readable stream

Gathering detailed insights and metrics for peek-readable

peek-readable - 7.0.0 | npmpackage.info

peek-readable

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

7.0.0

MIT

TypeScript

26.15 kB

627,013,521 5

Installations

npm install peek-readable

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>=18

Node Version

22.13.0

NPM Version

10.9.2 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

627,013,521

Last Day

1,268,379

Last Week

7,929,053

Last Month

31,214,559

Last Year

262,666,304

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

7.0.0

Package Id

peek-readable@7.0.0

Unpacked Size

26.15 kB

Size

6.92 kB

File Count

NPM Version

10.9.2

Node Version

22.13.0

Published on

Mar 09, 2025

Total Downloads

Cumulative downloads

Total Downloads

627,013,521

Last Day

15%

1,268,379

Compared to previous day

Last Week

9.6%

7,929,053

Compared to previous week

Last Month

17.1%

31,214,559

Compared to previous month

Last Year

51.8%

262,666,304

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@biomejs/biome @types/chai @types/chai-as-promised @types/mocha @types/node c8 chai chai-as-promised del-cli mocha node-readable-to-web-readable-stream remark-cli remark-preset-lint-recommended source-map-support ts-node typescript

peek-readable

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

Allows to read and peek from a Readable Stream

This module is used by strtok3

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

Class StreamReader is used to read from Node.js stream.Readable.
Class WebStreamByobReader is used to read from ReadableStream

Compatibility

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

For TypeScript CommonJs backward compatibility, you can use load-esm.

Usage

Installation

1npm install --save peek-readable

API Documentation

Both StreamReader and WebStreamByobReader implement the IStreamReader interface.

`IStreamReader` Interface

The IStreamReader interface defines the contract for a stream reader, which provides methods to read and peek data from a stream into a Uint8Array buffer. The methods are asynchronous and return a promise that resolves with the number of bytes read.

Methods

`peek` function

This method allows you to inspect data from the stream without advancing the read pointer. It reads data into the provided Uint8Array at a specified offset but does not modify the stream's internal position, allowing you to look ahead in the stream.

1peek(buffer: Uint8Array, offset: number, length: number): Promise<number>

Parameters:

buffer: Uint8Array: The buffer into which the data will be peeked. This is where the peeked data will be stored.
maybeBeLess: If true, the buffer maybe partially filled.

Returns Promise<number>: A promise that resolves with the number of bytes actually peeked into the buffer. This number may be less than the requested length if the end of the stream is reached.

`read` function

1read(buffer: Uint8Array, offset: number, length: number): Promise<number>

Parameters:

buffer: Uint8Array: The buffer into which the data will be read. This is where the read data will be stored.
maybeBeLess: If true, the buffer maybe partially filled.

Returns Promise<number>: A promise that resolves with the number of bytes actually read into the buffer. This number may be less than the requested length if the end of the stream is reached.

`abort` function

Abort active asynchronous operation (read or peak) before it has completed.

1abort(): Promise<void>

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);;
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);
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
4function closeNodeStream(stream: ReadStream): Promise<void> {
5  return new Promise<void>((resolve, reject) => {
6    stream.close(err => {
7      if(err)
8        reject(err);
9      else
10        resolve();
11    });
12  })
13}
14
15(async () => {
16
17  const fileReadStream = fs.createReadStream('JPEG_example_JPG_RIP_001.jpg');
18  try {
19    const streamReader = new StreamReader(fileReadStream);
20    try {
21      const buffer = Buffer.alloc(20);
22
23      let bytesRead = await streamReader.peek(buffer.subarray(0, 3));
24      if (bytesRead === 3 && buffer[0] === 0xFF && buffer[1] === 0xD8 && buffer[2] === 0xFF) {
25        console.log('This is a JPEG file');
26      } else {
27        throw Error('Expected a JPEG file');
28      }
29
30      bytesRead = await streamReader.read(buffer); // Read JPEG header
31      if (bytesRead === 20) {
32        console.log('Got the JPEG header');
33      } else {
34        throw Error('Failed to read JPEG header');
35      }
36    } finally {
37      await streamReader.close(); // Release fileReadStream
38    }    
39  } finally {
40    await closeNodeStream(fileReadStream);
41  }
42
43
44})();

Licence

This project is licensed under the MIT License. Feel free to use, modify, and distribute as needed.

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

Other packages similar to peek-readable

Other packages similar to peek-readable

peek-readable

Installations

Developer Guide

Yes

ESM

>=18

22.13.0

10.9.2

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

627,013,521

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

peek-readable

Compatibility

Usage

Installation

API Documentation

IStreamReader Interface

Methods

peek function

read function

abort function

Examples

Licence

10

10

10

10

10

10

0

0

0

0

0

0

0

5

/10

`IStreamReader` Interface

`peek` function

`read` function

`abort` function