ReadableStream - stream/web - Node documentation

interface ReadableStream

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

Type Parameters

R = any

readonly

locked: boolean

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

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

getReader(): ReadableStreamDefaultReader<R>

getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReader<R>

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>

R = any

variable ReadableStream

prototype: ReadableStream

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

ReadableStream class is a global reference for import { ReadableStream } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-readablestream

globalThis extends { onmessage: any; ReadableStream: infer T; } ? T : stream/web