Interface ReadableStream<R>

Readonlylocked

[asyncIterator]

• "[asyncIterator]"(): ReadableStreamAsyncIterator<R>

• Returns ReadableStreamAsyncIterator<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?: { preventCancel?: boolean }): ReadableStreamAsyncIterator<R>

• Parameters

  • Optionaloptions: { preventCancel?: boolean }

  Returns ReadableStreamAsyncIterator<R>