Class ReadableStream<R>

constructor

• new ReadableStream<R>(underlyingSource, strategy?): ReadableStream<R>

• Type Parameters

  • R = any

  Parameters

  • underlyingSource: UnderlyingByteSource

  • Optional strategy: {
        highWaterMark?: number;
    }

    • Optional highWaterMark?: number

  Returns ReadableStream<R>

• new ReadableStream<R>(underlyingSource, strategy?): ReadableStream<R>

• Type Parameters

  • R = any

  Parameters

  • underlyingSource: UnderlyingDefaultSource<R>

  • Optional strategy: QueuingStrategy<R>

  Returns ReadableStream<R>

• new ReadableStream<R>(underlyingSource?, strategy?): ReadableStream<R>

• Type Parameters

  • R = any

  Parameters

  • Optional underlyingSource: UnderlyingSource<R>

  • Optional strategy: QueuingStrategy<R>

  Returns ReadableStream<R>

Readonly locked

[asyncIterator]

• [asyncIterator](): AsyncIterableIterator<R>

• Returns AsyncIterableIterator<R>

cancel

• cancel(reason?): Promise<void>

• MDN Reference

  Parameters

  • Optional reason: any

  Returns Promise<void>

getReader

• getReader(options): ReadableStreamBYOBReader

• MDN Reference

  Parameters

  • options: {
        mode: "byob";
    }

    • mode: "byob"

  Returns ReadableStreamBYOBReader
• getReader(): ReadableStreamDefaultReader<R>

• Returns ReadableStreamDefaultReader<R>

• getReader(options?): ReadableStreamReader<R>

• Parameters

  • Optional options: ReadableStreamGetReaderOptions

  Returns ReadableStreamReader<R>

pipeThrough

• pipeThrough<T>(transform, options?): ReadableStream<T>

• MDN Reference

  Type Parameters

  • T

  Parameters

  • transform: ReadableWritablePair<T, R>

  • Optional options: StreamPipeOptions

  Returns ReadableStream<T>

pipeTo

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

• MDN Reference

  Parameters

  • destination: WritableStream<R>

  • Optional options: StreamPipeOptions

  Returns Promise<void>

tee

• tee(): [ReadableStream<R>, ReadableStream<R>]

• MDN Reference

  Returns [ReadableStream<R>, ReadableStream<R>]