Interface ReadableStream<R>

This Streams API interface represents a readable stream of byte data.

interface ReadableStream<R> {
    locked: boolean;
    [asyncIterator](): AsyncIterableIterator<R>;
    cancel(reason?: any): Promise<void>;
    getReader(): ReadableStreamDefaultReader<R>;
    getReader(options: {
        mode: "byob";
    }): 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?: {
        preventCancel?: boolean;
    }): AsyncIterableIterator<R>;
}

Type Parameters

  • R = any

Properties

locked

Methods

[asyncIterator] cancel getReader pipeThrough pipeTo tee values

Properties

Readonlylocked

locked: boolean

Methods

[asyncIterator]

cancel

  • cancel(reason?): Promise<void>

  • Parameters

    • Optionalreason: any

    Returns Promise<void>

getReader

pipeThrough

pipeTo

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

  • Parameters

    Returns Promise<void>

tee

values

  • values(options?): AsyncIterableIterator<R>

  • Parameters

    • Optionaloptions: {
          preventCancel?: boolean;
      }
      • OptionalpreventCancel?: boolean

    Returns AsyncIterableIterator<R>

Settings

Member Visibility

On This Page

Properties
Methods