Gathering detailed insights and metrics for @alexssmusica/peek-readable
Gathering detailed insights and metrics for @alexssmusica/peek-readable
A promise based asynchronous stream reader, which makes reading from a stream easy.
Installations
npm install @alexssmusica/peek-readableDeveloper 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
Releases
53
Languages
1
TypeScript
TypeScript (100%)
Developer
Borewit
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
8 Stars
888 Commits
7 Forks
2 Watchers
9 Branches
3 Contributors
Updated on Jun 08, 2025
Sponsor this package
Maintainers
1
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
11
NPM Version
6.14.17
Node Version
14.19.3
Published on
Jul 24, 2023
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
20
@types/chai@types/mocha@types/node@typescript-eslint/eslint-plugin@typescript-eslint/parserc8chaidel-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
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.
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
1 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Reason
Found 0/23 approved changesets -- score normalized to 0
Reason
1 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
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
dependency not pinned by hash detected -- score normalized to 0
Details
- 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: 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: 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
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
4
/10
Last Scanned on 2025-07-07
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