class Stream

Methods #

#compose<T extends ReadableStream>(stream: T
 | ComposeFnParam
 | Iterable<T>
 | AsyncIterable<T>,
options?: { signal: AbortSignal;  },
): T

#pipe<T extends WritableStream>(destination: T,
options?: { end?: boolean | undefined;  },
): T

namespace Stream

Classes #

Stream.Duplex

Duplex streams are streams that implement both the Readable and Writable interfaces.

Stream.PassThrough

The stream.PassThrough class is a trivial implementation of a Transform stream that simply passes the input bytes across to the output. Its purpose is primarily for examples and testing, but there are some use cases where stream.PassThrough is useful as a building block for novel sorts of streams.

Stream.Transform

Transform streams are Duplex streams where the output is in some way related to the input. Like all Duplex streams, Transform streams implement both the Readable and Writable interfaces.

Functions #

Stream.addAbortSignal

A stream to attach a signal to.

Stream.duplexPair

The utility function duplexPair returns an Array with two items, each being a Duplex stream connected to the other side:

Stream.finished

A readable and/or writable stream/webstream.

Stream.getDefaultHighWaterMark

Returns the default highWaterMark used by streams. Defaults to 65536 (64 KiB), or 16 for objectMode.

Stream.isErrored

Returns whether the stream has encountered an error.

Stream.isReadable

Returns whether the stream is readable.

Stream.pipeline

A module method to pipe between streams and generators forwarding errors and properly cleaning up and provide a callback when the pipeline is complete.

Stream.setDefaultHighWaterMark

Sets the default highWaterMark used by streams.