Usage in Deno
import * as mod from "node:stream";
A stream is an abstract interface for working with streaming data in Node.js.
The node:stream module provides an API for implementing the stream interface.
There are many stream objects provided by Node.js. For instance, a request to an HTTP server
and process.stdout are both stream instances.
Streams can be readable, writable, or both. All streams are instances of EventEmitter.
To access the node:stream module:
import stream from 'node:stream';
The node:stream module is useful for creating new types of stream instances.
It is usually not necessary to use the node:stream module to consume streams.
Classes #
Duplex streams are streams that implement both the Readable and Writable interfaces.
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.
- _construct
- _destroy
- _read
- addListener
- asIndexedPairs
- closed
- destroy
- destroyed
- drop
- emit
- errored
- every
- filter
- find
- flatMap
- forEach
- from
- fromWeb
- isDisturbed
- isPaused
- iterator
- map
- on
- once
- pause
- prependListener
- prependOnceListener
- push
- read
- readable
- readableAborted
- readableDidRead
- readableEncoding
- readableEnded
- readableFlowing
- readableHighWaterMark
- readableLength
- readableObjectMode
- reduce
- removeListener
- resume
- setEncoding
- some
- take
- toArray
- toWeb
- unpipe
- unshift
- wrap
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.
- _construct
- _destroy
- _final
- _write
- _writev
- addListener
- closed
- cork
- destroy
- destroyed
- emit
- end
- errored
- fromWeb
- on
- once
- prependListener
- prependOnceListener
- removeListener
- setDefaultEncoding
- toWeb
- uncork
- writable
- writableCorked
- writableEnded
- writableFinished
- writableHighWaterMark
- writableLength
- writableNeedDrain
- writableObjectMode
- write
Duplex streams are streams that implement both the Readable and Writable interfaces.
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.
- _construct
- _destroy
- _read
- addListener
- asIndexedPairs
- closed
- destroy
- destroyed
- drop
- emit
- errored
- every
- filter
- find
- flatMap
- forEach
- from
- fromWeb
- isDisturbed
- isPaused
- iterator
- map
- on
- once
- pause
- prependListener
- prependOnceListener
- push
- read
- readable
- readableAborted
- readableDidRead
- readableEncoding
- readableEnded
- readableFlowing
- readableHighWaterMark
- readableLength
- readableObjectMode
- reduce
- removeListener
- resume
- setEncoding
- some
- take
- toArray
- toWeb
- unpipe
- unshift
- wrap
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.
- _construct
- _destroy
- _final
- _write
- _writev
- addListener
- closed
- cork
- destroy
- destroyed
- emit
- end
- errored
- fromWeb
- on
- once
- prependListener
- prependOnceListener
- removeListener
- setDefaultEncoding
- toWeb
- uncork
- writable
- writableCorked
- writableEnded
- writableFinished
- writableHighWaterMark
- writableLength
- writableNeedDrain
- writableObjectMode
- write
Functions #
The utility function duplexPair returns an Array with two items,
each being a Duplex stream connected to the other side:
Returns the default highWaterMark used by streams.
Defaults to 65536 (64 KiB), or 16 for objectMode.
A module method to pipe between streams and generators forwarding errors and properly cleaning up and provide a callback when the pipeline is complete.
The utility function duplexPair returns an Array with two items,
each being a Duplex stream connected to the other side:
Returns the default highWaterMark used by streams.
Defaults to 65536 (64 KiB), or 16 for objectMode.
A module method to pipe between streams and generators forwarding errors and properly cleaning up and provide a callback when the pipeline is complete.