Interface ReadableStream<R>

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

interface ReadableStream<R> {
    get locked(): boolean;
    [asyncIterator](options?: ReadableStreamValuesOptions): AsyncIterableIterator<R, any, any>;
    cancel(reason?: any): Promise<void>;
    getReader(): ReadableStreamDefaultReader<R>;
    getReader(options: ReadableStreamGetReaderOptions): ReadableStreamBYOBReader;
    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?: ReadableStreamValuesOptions): AsyncIterableIterator<R, any, any>;
}

Type Parameters

  • R = any

Accessors

locked

Methods

[asyncIterator] cancel getReader pipeThrough pipeTo tee values

Accessors

locked

  • get locked(): boolean

  • Returns boolean

Methods

[asyncIterator]

  • [asyncIterator](options?): AsyncIterableIterator<R, any, any>

  • Parameters

    Returns AsyncIterableIterator<R, any, any>

cancel

  • cancel(reason?): Promise<void>

  • Parameters

    • Optionalreason: any

    Returns Promise<void>

getReader

pipeThrough

pipeTo

tee

values

  • values(options?): AsyncIterableIterator<R, any, any>

  • Parameters

    Returns AsyncIterableIterator<R, any, any>

Settings

Member Visibility

On This Page

Accessors
Methods