npmpackage.info

Gathering detailed insights and metrics for stream-head

Other packages similar to stream-head

sandwich-stream

2.0.2

A readable stream that concatenates multiple streams with optional head, tail & join buffers

head-stream

0.0.4

Passthrough stream for acting upon the first buffer emitted in a stream. Like the head command of e.g. head and tail, first and rest.

quiver-stream-head-extractor

0.0.2

quiver-stream-head-extractor ============================

head-tail-stream

0.1.2

Output the first or last lines of a stream

Gathering detailed insights and metrics for stream-head

stream-head - 3.0.0 | npmpackage.info

stream-head

Peek the first couple of bytes from a stream

3.0.0

TypeScript

10.92 kB

2,757,970 2.2

Installations

npm install stream-head

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>=14.13.1

Node Version

18.13.0

NPM Version

8.19.3 Score

99.2

Supply Chain

82.8

Quality

74.8

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

1

Closed

1

Issues

Open

0

Total

4

Closed

4

Releases

v3.0.0

Updated on Feb 07, 2023

v2.0.2

Updated on Nov 23, 2020

v2.0.1

Updated on Nov 23, 2020

v2.0.0

Updated on Nov 22, 2020

View All 4 releases

Languages

TypeScript

JavaScript

TypeScript (97.24%)

JavaScript (2.76%)

Developer

grantila

Download Statistics

Total Downloads

2,757,970

Last Day

8,801

Last Week

50,100

Last Month

251,967

Last Year

1,282,180

GitHub Statistics

4 Stars

18 Commits

1 Watchers

1 Branches

1 Contributors

Updated on Nov 01, 2024

Bundle Size

37.72 kB

Minified

10.92 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

3.0.0

Package Id

stream-head@3.0.0

Unpacked Size

9.47 kB

Size

3.17 kB

File Count

NPM Version

8.19.3

Node Version

18.13.0

Published on

Feb 07, 2023

Total Downloads

Cumulative downloads

Total Downloads

2,757,970

Last Day

17%

8,801

Compared to previous day

Last Week

-15%

50,100

Compared to previous week

Last Month

11.5%

251,967

Compared to previous month

Last Year

79.7%

1,282,180

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

through2

Dev Dependencies

@babel/preset-env @babel/preset-typescript @types/jest @types/node @types/through2 cz-conventional-changelog jest pre-commit rimraf ts-jest-resolver typescript web-streams-polyfill

stream-head

This package allows for inspecting the first n bytes from a stream. A kind of "POSIX head(1) for JavaScript".

It handles both Node.js streams and Whatwg streams (the Web Streams API used in browsers).

This package provides TypeScript types.

Versions

From v3:

This package is a pure ESM, no CommonJS support

API

The default (and only) exported function takes a readable stream and returns a new readable stream stream of the same type as the input stream, together with head of type Uint8Array. The old stream must not be used anymore, it will be piped to the returned stream. The returned stream will contain everything from the input stream, the first n bytes will be copied to the returned buffer, not consumed. If the stream doesn't contain n bytes, head will be smaller. If the combined chunks up until n are larger than n, then head will be larger than n too (it's not truncated).

If the stream is a Node.js ReadableStream it must not be in object-mode but rather transport Node.js Buffers (or typed arrays), and if the stream is a Whatwg ReadableStream, the chunks in the stream (at least up until n bytes) must be typed arrays (such as e.g. Uint8Array), ArrayBuffers or DataViews.

1import streamHead from 'stream-head'
2
3inputStream; // We get this from somewhere
4
5// Peek the first 64 bytes from the stream.
6const { stream, head } = await streamHead( inputStream, { bytes: 64 } );
7
8stream; // The new stream (don't use inputStream anymore!)
9head; // A Uint8Array with the first *at least* 64 bytes (or less if the stream was smaller)

For TypeScript

In tsconfig.json, lib needs to include "DOM" and types need to include "node" because this package support both DOM ReadableStream and Node.js' NodeJS.ReadableStream type.

No vulnerabilities found.

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.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

Token-Permissions

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

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

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

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.2

/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