Gathering detailed insights and metrics for @caoer/peek-readable
Gathering detailed insights and metrics for @caoer/peek-readable
A promise based asynchronous stream reader, which makes reading from a stream easy.
Installations
npm install @caoer/peek-readableDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Min. Node Version
>=14.16
Node Version
16.12.0
NPM Version
8.1.0
Score
70.1
Supply Chain
97.4
Quality
75.3
Maintenance
100
Vulnerability
100
License
Releases
53
Languages
1
TypeScript
TypeScript (100%)
Developer
Borewit
Download Statistics
Total Downloads
641
Last Day
1
Last Week
7
Last Month
21
Last Year
128
GitHub Statistics
MIT License
8 Stars
887 Commits
7 Forks
2 Watchers
8 Branches
3 Contributors
Updated on May 07, 2025
Sponsor this package
Maintainers
1
Package Meta Information
Latest Version
5.0.1
Package Id
@caoer/peek-readable@5.0.1
Unpacked Size
15.45 kB
Size
4.88 kB
File Count
11
NPM Version
8.1.0
Node Version
16.12.0
Total Downloads
Cumulative downloads
Total Downloads
641
Last Day
0%
1
Compared to previous day
Last Week
133.3%
7
Compared to previous week
Last Month
5%
21
Compared to previous month
Last Year
-17.9%
128
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
21
@types/chai@types/mocha@types/node@typescript-eslint/eslint-plugin@typescript-eslint/parserc8chaicoverallsdel-clieslinteslint-config-prettiereslint-import-resolver-typescripteslint-plugin-importeslint-plugin-jsdoceslint-plugin-nodeeslint-plugin-unicornmocharemark-cliremark-preset-lint-recommendedts-nodetypescript
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
StreamReaderis used to read from Node.js stream.Readable. - Class
WebStreamByobReaderis 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.
Reason
15 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE.txt:0
- Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0
Reason
SAST tool is run on all commits
Details
- Info: all commits (17) are checked with a SAST tool
Reason
0 existing vulnerabilities detected
Reason
Found 0/23 approved changesets -- score normalized to 0
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
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/release-drafter.yml:16
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/post-dependabot-prs.yml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/release-drafter.yml:11
- Warn: no topLevel permission defined: .github/workflows/update-license.yml:1
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
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