Node Reference for ReadableStream

interface ReadableStream

import { type ReadableStream } from "node:stream/web";

This Streams API interface represents a readable stream of byte data.

Type Parameters



R = any

readonly



locked: boolean



cancel(reason?: any): Promise<void>



getReader(): ReadableStreamDefaultReader<R>



getReader(options: { mode: "byob";  }): ReadableStreamBYOBReader



pipeThrough<T>(transform: ReadableWritablePair<T, R>,
options?: StreamPipeOptions,
): ReadableStream<T>



pipeTo(destination: WritableStream<R>,
options?: StreamPipeOptions,
): Promise<void>



tee(): [ReadableStream<R>, ReadableStream<R>]



values(options?: { preventCancel?: boolean;  }): AsyncIterableIterator<R>



[[Symbol.asyncIterator]](): AsyncIterableIterator<R>

variable ReadableStream



prototype: ReadableStream



from<T>(iterable: Iterable<T> | AsyncIterable<T>): ReadableStream<T>