Class Stream<T>

constructor

• new Stream<T>(
      responseBody: ReadableStream<Uint8Array<ArrayBufferLike>>,
      parse: (x: SseMessage<string>) => IteratorResult<T, undefined>,
      opts?: { dataRequired?: boolean },
  ): Stream<T>

  Type Parameters

  • T

  Parameters

  • responseBody: ReadableStream<Uint8Array<ArrayBufferLike>>
  • parse: (x: SseMessage<string>) => IteratorResult<T, undefined>
  • Optionalopts: { dataRequired?: boolean }

  Returns Stream<T>

Readonlylocked

[asyncIterator]

• "[asyncIterator]"(options?: unknown): StreamAsyncIterator<T>

  Parameters

  • Optionaloptions: unknown

  Returns StreamAsyncIterator<T>

cancel

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

  MDN Reference

  Parameters

  • Optionalreason: any

  Returns Promise<void>

getReader

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

  MDN Reference

  Parameters

  • options: { mode: "byob" }

  Returns ReadableStreamBYOBReader
• getReader(): ReadableStreamDefaultReader<T>

  Returns ReadableStreamDefaultReader<T>

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

  Parameters

  • Optionaloptions: ReadableStreamGetReaderOptions

  Returns ReadableStreamReader<T>

pipeThrough

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

  MDN Reference

  Type Parameters

  • T

  Parameters

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

  Returns ReadableStream<T>

pipeTo

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

  MDN Reference

  Parameters

  • destination: WritableStream<T>
  • Optionaloptions: StreamPipeOptions

  Returns Promise<void>

tee

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

  MDN Reference

  Returns [ReadableStream<T>, ReadableStream<T>]

values

• values(options?: unknown): StreamAsyncIterator<T>

  Parameters

  • Optionaloptions: unknown

  Returns StreamAsyncIterator<T>