Skip to main content
default - stream - Node documentation
class default
extends EventEmitter

Usage in Deno

import mod from "node: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 default

Classes

c
default.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.

c
default.Readable
No documentation available
c
default.Stream
No documentation available
c
default.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.

c
default.Writable
No documentation available

Functions

f
default.addAbortSignal

A stream to attach a signal to.

f
default.duplexPair

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

f
N
default.finished

A readable and/or writable stream/webstream.

f
default.getDefaultHighWaterMark

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

f
default.isErrored

Returns whether the stream has encountered an error.

f
default.isReadable

Returns whether the stream is readable.

f
N
default.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.

f
default.setDefaultHighWaterMark

Sets the default highWaterMark used by streams.

Interfaces

Type Aliases

T
default.PipelineCallback
No documentation available
T
default.PipelineDestination
No documentation available
T
T
default.PipelineDestinationPromiseFunction
No documentation available
T
default.PipelinePromise
No documentation available
T
default.PipelineSource
No documentation available
T
default.PipelineSourceFunction
No documentation available
T
default.PipelineTransform
No documentation available
T
default.PipelineTransformSource
No documentation available
T
default.TransformCallback
No documentation available

Variables

v
default.consumers
No documentation available
v
default.promises
No documentation available