ReadableStream
interface
interface 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.
variable
var ReadableStream: { … }The constructor object for ReadableStream, used to create a
readable stream from an underlying source describing how data is enqueued and
consumed.
Constructors
constructor
new ReadableStream(underlyingSource: UnderlyingByteSource, strategy?: { highWaterMark?: number }): ReadableStream<Uint8Array<ArrayBuffer>>new ReadableStream<R = any>(underlyingSource: UnderlyingDefaultSource<R>, strategy?: QueuingStrategy<R>): ReadableStream<R>new ReadableStream<R = any>(underlyingSource?: UnderlyingSource<R>, strategy?: QueuingStrategy<R>): ReadableStream<R>Properties
locked
readonly locked: booleanprototype
readonly prototype: ReadableStreamMethods
cancel
cancel(reason?: any): Promise<void>getReader
getReader(options: { mode: "byob" }): ReadableStreamBYOBReadergetReader(): ReadableStreamDefaultReader<R>getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReader<R>pipeThrough
pipeThrough<T>(transform: ReadableWritablePair<T, R>, options?: StreamPipeOptions): ReadableStream<T>pipeTo
pipeTo(destination: WritableStream<R>, options?: StreamPipeOptions): Promise<void>tee
tee(): [ReadableStream<R>, ReadableStream<R>]values
values(options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R>[Symbol.asyncIterator]
[Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R>from
from<R>(asyncIterable: AsyncIterable<R> | Iterable<R | PromiseLike<R>> & object): ReadableStream<R>