Skip to main content
Home

@std/streams@1.0.16
Built and signed on GitHub Actions

Utilities for working with the Web Streams API

This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score
100%
Published
6 days ago (1.0.16)

default

Utilities for working with the Streams API.

c
Buffer

A variable-sized buffer of bytes with readable and writable getters that allows you to work with Web Streams API.

I
BufferBytesOptions

Options for Buffer.bytes.

c
ByteSliceStream

A transform stream that only transforms from the zero-indexed start and end bytes (both inclusive).

f
concatReadableStreams

Concatenates multiple ReadableStreams into a single ordered ReadableStream.

T
DelimiterDisposition

Disposition of the delimiter for DelimiterStreamOptions.

c
DelimiterStream

Divide a stream into chunks delimited by a given byte sequence.

I
DelimiterStreamOptions

Options for DelimiterStream.

f
earlyZipReadableStreams

Merge multiple streams into a single one, taking order into account, and each stream will wait for a chunk to enqueue before the next stream can append another chunk.

c
LimitedBytesTransformStream

A TransformStream that will only read & enqueue chunks until the total amount of enqueued data exceeds size. The last chunk that would exceed the limit will NOT be enqueued, in which case a RangeError is thrown when options.error is set to true, otherwise the stream is just terminated.

I
LimitedBytesTransformStreamOptions

Options for LimitedBytesTransformStream.

c
LimitedTransformStream

A TransformStream that will only read & enqueue size amount of chunks.

I
LimitedTransformStreamOptions

Options for LimitedTransformStream

f
mergeReadableStreams

Merge multiple streams into a single one, not taking order into account. If a stream ends before other ones, the other will continue adding data, and the finished one will not add any more data.

c
TextDelimiterStream

Transform a stream string into a stream where each chunk is divided by a given delimiter.

c
TextLineStream

Transform a stream into a stream where each chunk is divided by a newline, be it \n or \r\n. \r can be enabled via the allowCR option.

I
TextLineStreamOptions

Options for TextLineStream.

f
toArrayBuffer

Converts a ReadableStream of Uint8Arrays to an ArrayBuffer. Works the same as Response.arrayBuffer.

f
toBlob

Converts a ReadableStream of Uint8Arrays to a Blob. Works the same as Response.blob.

f
toJson

Converts a https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON-formatted ReadableSteam of strings or Uint8Arrays to an object. Works the same as Response.json and Request.json, but also extends to support streams of strings.

f
toText

Converts a ReadableSteam of strings or Uint8Arrays to a single string. Works the same as Response.text and Request.text, but also extends to support streams of strings.

f
toTransformStream

Convert the generator function into a TransformStream.

f
zipReadableStreams

Merge multiple streams into a single one, taking order into account, and each stream will wait for a chunk to enqueue before the next stream can append another chunk.

c
Buffer

A variable-sized buffer of bytes with readable and writable getters that allows you to work with Web Streams API.

I
BufferBytesOptions

Options for Buffer.bytes.

c
ByteSliceStream

A transform stream that only transforms from the zero-indexed start and end bytes (both inclusive).

f
concatReadableStreams

Concatenates multiple ReadableStreams into a single ordered ReadableStream.

T
DelimiterDisposition

Disposition of the delimiter for DelimiterStreamOptions.

c
DelimiterStream

Divide a stream into chunks delimited by a given byte sequence.

I
DelimiterStreamOptions

Options for DelimiterStream.

f
earlyZipReadableStreams

Merge multiple streams into a single one, taking order into account, and each stream will wait for a chunk to enqueue before the next stream can append another chunk.

c
LimitedBytesTransformStream

A TransformStream that will only read & enqueue chunks until the total amount of enqueued data exceeds size. The last chunk that would exceed the limit will NOT be enqueued, in which case a RangeError is thrown when options.error is set to true, otherwise the stream is just terminated.

I
LimitedBytesTransformStreamOptions

Options for LimitedBytesTransformStream.

c
LimitedTransformStream

A TransformStream that will only read & enqueue size amount of chunks.

I
LimitedTransformStreamOptions

Options for LimitedTransformStream

f
mergeReadableStreams

Merge multiple streams into a single one, not taking order into account. If a stream ends before other ones, the other will continue adding data, and the finished one will not add any more data.

c
TextDelimiterStream

Transform a stream string into a stream where each chunk is divided by a given delimiter.

c
TextLineStream

Transform a stream into a stream where each chunk is divided by a newline, be it \n or \r\n. \r can be enabled via the allowCR option.

I
TextLineStreamOptions

Options for TextLineStream.

f
toArrayBuffer

Converts a ReadableStream of Uint8Arrays to an ArrayBuffer. Works the same as Response.arrayBuffer.

f
toBlob

Converts a ReadableStream of Uint8Arrays to a Blob. Works the same as Response.blob.

f
toJson

Converts a https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON-formatted ReadableSteam of strings or Uint8Arrays to an object. Works the same as Response.json and Request.json, but also extends to support streams of strings.

f
toText

Converts a ReadableSteam of strings or Uint8Arrays to a single string. Works the same as Response.text and Request.text, but also extends to support streams of strings.

f
toTransformStream

Convert the generator function into a TransformStream.

c
AbortStream

A transform stream that accepts a AbortSignal to easily abort a stream pipeThrough.

I
CappedDelimiterEntry

Represents an entry in a CappedDelimiterStream.

I
CappedDelimiterOptions

The options for the CappedDelimiterStream.

c
CappedDelimiterStream

CappedDelimiterStream is a TransformStream that splits a ReadableStream<Uint8Array> by a provided delimiter, returning CappedDelimiterEntry objects. Each entry's match property indicates whether the corresponding value ended with the delimiter. The class also requires a limit property to specify the max length that each entry can be, which can be preferable if your delimiter is unlikely to appear often.

c
FixedChunkStream

A transform stream that resize Uint8Array chunks into perfectly size chunks with the exception of the last chunk.

f
toByteStream

The function takes a ReadableStream<Uint8Array> and wraps it in a BYOB stream if it doesn't already support it.

f
toBytes

Converts a ReadableStream of Uint8Arrays to a Uint8Array. Works the same as Response.bytes.

f
toLines

Converts a ReadableStream of Uint8Arrays into one of lines delimited by \n or \r\n. Trims the last line if empty.

f
zipReadableStreams

Merge multiple streams into a single one, taking order into account, and each stream will wait for a chunk to enqueue before the next stream can append another chunk.

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.