Interface ReadableStream<R>

Readonlylocked

cancel

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

  The cancel() method of the ReadableStream interface returns a Promise that resolves when the stream is canceled.

  MDN Reference

  Parameters

  • Optionalreason: any

  Returns Promise<void>

getReader

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

  The getReader() method of the ReadableStream interface creates a reader and locks the stream to it.

  MDN Reference

  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>

  The pipeThrough() method of the ReadableStream interface provides a chainable way of piping the current stream through a transform stream or any other writable/readable pair.

  MDN Reference

  Type Parameters

  • T

  Parameters

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

  Returns ReadableStream<T>

pipeTo

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

  The pipeTo() method of the ReadableStream interface pipes the current ReadableStream to a given WritableStream and returns a Promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered.

  MDN Reference

  Parameters

  • destination: WritableStream<R>
  • Optionaloptions: StreamPipeOptions

  Returns Promise<void>

tee

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

  The tee() method of the two-element array containing the two resulting branches as new ReadableStream instances.

  MDN Reference

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