Gathering detailed insights and metrics for buffer-peek-stream
Gathering detailed insights and metrics for buffer-peek-stream
Node Transform stream that lets you inspect the start of a ReadStream before deciding what to do with it
Installations
npm install buffer-peek-streamDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
12.13.1
NPM Version
6.12.1
Score
83.8
Supply Chain
87.6
Quality
77.8
Maintenance
100
Vulnerability
100
License
Languages
1
JavaScript
JavaScript (100%)
Developer
seangarner
Download Statistics
Total Downloads
12,611,129
Last Day
1,148
Last Week
8,076
Last Month
31,391
Last Year
1,556,663
GitHub Statistics
MIT License
7 Stars
23 Commits
4 Forks
1 Watchers
2 Branches
3 Contributors
Updated on Apr 05, 2022
Bundle Size
1.07 kB
Minified
551.00 B
Minified + Gzipped
Maintainers
2
Package Meta Information
Latest Version
1.1.0
Package Id
buffer-peek-stream@1.1.0
Size
3.73 kB
NPM Version
6.12.1
Node Version
12.13.1
Published on
Feb 02, 2020
Total Downloads
Cumulative downloads
Total Downloads
12,611,129
Dev Dependencies
6
node-buffer-peek-stream
Take a peek at the start of a stream and get back a new stream rewound from the start without buffering the entire stream. Useful when you need to inspect the start of the stream before deciding what to do with the stream.
npm install buffer-peek-stream
Useful if you want to inspect the start of a stream before deciding what to do with it.
This works with buffers and does no string decoding. If you know you have a string and already know its encoding then checkout peek-stream.
Usage
As a promise (with await)...
const peek = require('buffer-peek-stream').promise;
const readstream = fs.createReadStream('package.json');
const [data, outputStream] = await peek(readstream, 65536);
// outputStream is ready to be piped somewhere else
outputStream.pipe(somewhere_else);
As a callback...
var peek = require('buffer-peek-stream');
var readstream = fs.createReadStream('package.json');
peek(readstream, 65536, function (err, data, outputStream) {
if (err) throw err;
// outputStream is ready to be piped somewhere else
outputStream.pipe(somewhere_else);
});
As a stream...
var PeekStream = require('buffer-peek-stream').BufferPeekStream;
var peek = new PeekStream(65536);
var readstream = fs.createReadStream('package.json');
// peek will only emit the peek event once
peek.once('peek', function (buf) {
// readstream is ready to be piped somewhere else
peek.pipe(somewhere_else);
});
readstream.pipe(peek);
// alternatively pipe `peek` here instead of in `data` callback
Licence
MIT
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:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/seangarner/node-buffer-peek-stream/node.js.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/seangarner/node-buffer-peek-stream/node.js.yml/master?enable=pin
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 1 out of 1 npmCommand dependencies pinned
Reason
7 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 1/19 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/node.js.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
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
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
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 6 are checked with a SAST tool
Score
3
/10
Last Scanned on 2025-04-28
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