Class TextStreamReader

constructor

• new TextStreamReader(
      info: TextStreamInfo,
      stream: ReadableStream<DataStream_Chunk>,
      totalChunkCount?: number,
  ): 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

  Returns TextStreamReader

OptionalonProgress

[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(): Promise<string>

  Returns Promise<string>