Class ByteStreamReader

constructor

• new ByteStreamReader(
      info: ByteStreamInfo,
      stream: ReadableStream<DataStream_Chunk>,
      totalByteSize?: number,
  ): ByteStreamReader

  Parameters

  • info: ByteStreamInfo
  • stream: ReadableStream<DataStream_Chunk>
  • OptionaltotalByteSize: number

  Returns ByteStreamReader

OptionalonProgress

Optionalsignal

[asyncIterator]

• "[asyncIterator]"(): {
      next: () => Promise<IteratorResult<Uint8Array<ArrayBufferLike>, any>>;
      return(): Promise<IteratorResult<Uint8Array<ArrayBufferLike>, any>>;
  }

  Returns {
      next: () => Promise<IteratorResult<Uint8Array<ArrayBufferLike>, any>>;
      return(): Promise<IteratorResult<Uint8Array<ArrayBufferLike>, any>>;
  }

readAll

• readAll(
      opts?: BaseStreamReaderReadAllOpts,
  ): Promise<Uint8Array<ArrayBufferLike>[]>

  Parameters

  • opts: BaseStreamReaderReadAllOpts = {}

  Returns Promise<Uint8Array<ArrayBufferLike>[]>

withAbortSignal

• withAbortSignal(signal: AbortSignal): ByteStreamReader

  Injects an AbortSignal, which if aborted, will terminate the currently active stream iteration operation.

  Note that when using AbortSignal.timeout(...), the timeout applies across the whole iteration operation, not just one individual chunk read.

  Parameters

  • signal: AbortSignal

  Returns ByteStreamReader