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 = any> {
    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

Readonlylocked

locked: boolean

MDN Reference

Methods

cancel

  • cancel(reason?: any): Promise<void>

    MDN Reference

    Parameters

    • Optionalreason: any

    Returns Promise<void>

getReader

pipeThrough

pipeTo

tee

Settings

Member Visibility

On This Page

Properties
Methods
MMNEPVFCICPMFPCPTTAAATR