Class TextStreamReader

constructor

• new TextStreamReader(
      info: TextStreamInfo,
      stream: ReadableStream<DataStream_Chunk>,
      totalChunkCount?: number,
      outOfBandFailureRejectingFuture?: Future<never>,
  ): TextStreamReader

  A TextStreamReader instance can be used as an AsyncIterator that returns the entire string that has been received up to the current point in time.

  Parameters

  • info: TextStreamInfo
  • stream: ReadableStream<DataStream_Chunk>
  • OptionaltotalChunkCount: number
  • OptionaloutOfBandFailureRejectingFuture: Future<never>

  Returns TextStreamReader

OptionalonProgress

Optionalsignal

[asyncIterator]

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

  Async iterator implementation to allow usage of for await...of syntax. Yields structured chunks from the stream.

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

readAll

• readAll(opts?: BaseStreamReaderReadAllOpts): Promise<string>

  Parameters

  • opts: BaseStreamReaderReadAllOpts = {}

  Returns Promise<string>

withAbortSignal

• withAbortSignal(signal: AbortSignal): TextStreamReader

  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 TextStreamReader