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

Usage in Deno

import { internal } 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 internal

Classes

c
internal.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 isprimarily 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
internal.Readable
No documentation available
c
internal.Stream
No documentation available
c
internal.Transform

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

c
internal.Writable
No documentation available

Functions

f
internal.addAbortSignal

A stream to attach a signal to.

f
internal.duplexPair

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

f
N
internal.finished

A readable and/or writable stream/webstream.

f
internal.getDefaultHighWaterMark

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

f
internal.isErrored

Returns whether the stream has encountered an error.

f
internal.isReadable

Returns whether the stream is readable.

f
N
internal.pipeline

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

f
internal.setDefaultHighWaterMark

Sets the default highWaterMark used by streams.

Interfaces

Type Aliases

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

Variables

v
internal.consumers
No documentation available
v
internal.promises
No documentation available