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.

interface ReadableStream<R> {
    locked: boolean;
    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>];
}

Type Parameters

  • R = any

Properties

locked

Methods

cancel getReader pipeThrough pipeTo tee

Properties

Readonlylocked

locked: boolean

Methods

cancel

  • cancel(reason?): Promise<void>

  • Parameters

    • Optionalreason: any

    Returns Promise<void>

getReader

pipeThrough

pipeTo

  • pipeTo(destination, options?): Promise<void>

  • Parameters

    Returns Promise<void>

tee

Settings

Member Visibility

On This Page

Properties
Methods