Class TextStreamReader

A class to read chunks from a ReadableStream and provide them in a structured format.

Hierarchy

BaseStreamReader<TextStreamInfo>
- TextStreamReader

Index

Constructors

Properties

_info bytesReceived onProgress? reader totalByteSize?

Accessors

Methods

[asyncIterator] handleChunkReceived readAll

Constructors

constructor

new TextStreamReader(
    info: BaseStreamInfo,
    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: BaseStreamInfo
- stream: ReadableStream<DataStream_Chunk>
- OptionaltotalChunkCount: number
Returns TextStreamReader
Overrides BaseStreamReader<TextStreamInfo>.constructor
- Defined in packages/livekit-rtc/src/data_streams/stream_reader.ts:93

Properties

`Protected`_info

_info: BaseStreamInfo

`Protected`bytesReceived

bytesReceived: number

`Optional`onProgress

onProgress?: (progress: undefined | number) => void

`Protected`reader

reader: ReadableStream<DataStream_Chunk>

`Protected` `Optional`totalByteSize

totalByteSize?: number

Accessors

info

get info(): T
Returns T
Inherited from BaseStreamReader.info
- Defined in packages/livekit-rtc/src/data_streams/stream_reader.ts:18

Methods

[asyncIterator]

"[asyncIterator]"(): {
next: () => Promise<IteratorResult<string, any>>;
return(): IteratorResult<string>;
}
Async iterator implementation to allow usage of for await...of syntax. Yields structured chunks from the stream.

Returns {
next: () => Promise<IteratorResult<string, any>>;
return(): IteratorResult<string>;
}
- Defined in packages/livekit-rtc/src/data_streams/stream_reader.ts:121

`Protected`handleChunkReceived

handleChunkReceived(chunk: DataStream_Chunk): void
Parameters
- chunk: DataStream_Chunk
Returns void
Overrides BaseStreamReader.handleChunkReceived
- Defined in packages/livekit-rtc/src/data_streams/stream_reader.ts:102

readAll

readAll(): Promise<string>
Returns Promise<string>
Overrides BaseStreamReader.readAll
- Defined in packages/livekit-rtc/src/data_streams/stream_reader.ts:151