ReadableStream - Streams - Web documentation

Streams

ReadableStream

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(): 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?: ReadableStreamIteratorOptions): AsyncIterableIterator<R>

#[[Symbol.asyncIterator]](options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R>

variable ReadableStream

Properties #

readonly

#prototype: ReadableStream

Methods #

#from<R>(asyncIterable: AsyncIterable<R> | Iterable<R | PromiseLike<R>> & object): ReadableStream<R>