Symbol

ReadableStream

class ReadableStream<R = any>

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.

MDN Reference

readonly locked: boolean
MDN Reference
[Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIterator<R>
cancel(reason?: any): Promise<void>
MDN Reference
getReader(options: { mode: 'byob' }): ReadableStreamBYOBReader
MDN Reference
getReader(): ReadableStreamDefaultReader<R>
getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReader<R>
pipeThrough<T>(transform: ReadableWritablePair<T, R>, options?: StreamPipeOptions): ReadableStream<T>
MDN Reference
pipeTo(destination: WritableStream<R>, options?: StreamPipeOptions): Promise<void>
MDN Reference
tee(): [ReadableStream<R>, ReadableStream<R>]
MDN Reference
values(options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIterator<R>