ReadableStream - Web documentation
interface ReadableStream

This Streams API interface represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object.

Type Parameters

R = any

Properties

readonly
locked: boolean

Methods

cancel(reason?: any): Promise<void>
getReader(options: { mode: "byob"; }): ReadableStreamBYOBReader
getReader(options?: { mode?: undefined; }): ReadableStreamDefaultReader<R>
pipeThrough<T>(
transform: { writable: WritableStream<R>; readable: ReadableStream<T>; },
options?: PipeOptions,
): ReadableStream<T>
pipeTo(
options?: PipeOptions,
): Promise<void>
values(options?: { preventCancel?: boolean; }): AsyncIterableIterator<R>
[[Symbol.asyncIterator]](options?: { preventCancel?: boolean; }): AsyncIterableIterator<R>