Class ReadableStream<R>

constructor

• new ReadableStream<R = any>(
      underlyingSource: UnderlyingByteSource,
      strategy?: { highWaterMark?: number },
  ): ReadableStream<R>

  Type Parameters

  • R = any

  Parameters

  • underlyingSource: UnderlyingByteSource
  • Optionalstrategy: { highWaterMark?: number }

  Returns ReadableStream<R>

• new ReadableStream<R = any>(
      underlyingSource: UnderlyingDefaultSource<R>,
      strategy?: QueuingStrategy<R>,
  ): ReadableStream<R>

  Type Parameters

  • R = any

  Parameters

  • underlyingSource: UnderlyingDefaultSource<R>
  • Optionalstrategy: QueuingStrategy<R>

  Returns ReadableStream<R>

• new ReadableStream<R = any>(
      underlyingSource?: UnderlyingSource<R>,
      strategy?: QueuingStrategy<R>,
  ): ReadableStream<R>

  Type Parameters

  • R = any

  Parameters

  • OptionalunderlyingSource: UnderlyingSource<R>
  • Optionalstrategy: QueuingStrategy<R>

  Returns ReadableStream<R>

Readonlylocked

[asyncIterator]

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

  Parameters

  • Optionaloptions: ReadableStreamIteratorOptions

  Returns AsyncIterableIterator<R>

cancel

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

  Parameters

  • Optionalreason: any

  Returns Promise<void>

getReader

• getReader(options: { mode: "byob" }): ReadableStreamBYOBReader

  Parameters

  • options: { mode: "byob" }

  Returns ReadableStreamBYOBReader

• getReader(): ReadableStreamDefaultReader<R>

  Returns ReadableStreamDefaultReader<R>

• getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReader<R>

  Parameters

  • Optionaloptions: ReadableStreamGetReaderOptions

  Returns ReadableStreamReader<R>

pipeThrough

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

  Type Parameters

  • T

  Parameters

  • transform: ReadableWritablePair<T, R>
  • Optionaloptions: StreamPipeOptions

  Returns ReadableStream<T>

pipeTo

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

  Parameters

  • destination: WritableStream<R>
  • Optionaloptions: StreamPipeOptions

  Returns Promise<void>

tee

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

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

values

• values(options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R>

  Parameters

  • Optionaloptions: ReadableStreamIteratorOptions

  Returns AsyncIterableIterator<R>