Class StreamingAsyncIterator

Implements

AsyncIterableIterator<LanguageModelStreamResponsePart>
Disposable

Index

Constructors

Properties

done messageCache requestQueue stream terminalError toDispose

Methods

[asyncIterator] dispose handleIncoming next registerStreamListener

Constructors

constructor

new StreamingAsyncIterator(
stream: ChatCompletionStream,
cancellationToken?: CancellationToken,
): StreamingAsyncIterator
Parameters
- stream: ChatCompletionStream
- OptionalcancellationToken: CancellationToken
Returns StreamingAsyncIterator
- Defined in src/node/openai-streaming-iterator.ts:32

Properties

`Protected`done

done: boolean = false

`Protected` `Readonly`messageCache

messageCache: LanguageModelStreamResponsePart[] = ...

`Protected` `Readonly`requestQueue

requestQueue: Deferred<IterResult>[] = ...

`Protected` `Readonly`stream

stream: ChatCompletionStream

`Protected`terminalError

terminalError: undefined | Error = undefined

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterableIterator<LanguageModelStreamResponsePart>
Returns AsyncIterableIterator<LanguageModelStreamResponsePart>
Implementation of AsyncIterableIterator.[asyncIterator]
- Defined in src/node/openai-streaming-iterator.ts:100

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of Disposable.dispose
- Defined in src/node/openai-streaming-iterator.ts:149

`Protected`handleIncoming

handleIncoming(message: LanguageModelStreamResponsePart): void
Parameters
- message: LanguageModelStreamResponsePart
Returns void
- Defined in src/node/openai-streaming-iterator.ts:126

next

next(): Promise<IterResult>
NOTE: 'next' is defined using a tuple to ensure we report the correct assignability errors in all places.

Returns Promise<IterResult>
Implementation of AsyncIterableIterator.next
- Defined in src/node/openai-streaming-iterator.ts:102

`Protected`registerStreamListener

registerStreamListener<Event extends keyof ChatCompletionStreamEvents<null>>(
    eventType: Event,
    handler: ChatCompletionStreamEvents<null>[Event],
    once?: boolean,
): void
Type Parameters
- Event extends keyof ChatCompletionStreamEvents<null>
Parameters
- eventType: Event
- handler: ChatCompletionStreamEvents<null>[Event]
- Optionalonce: boolean
Returns void
- Defined in src/node/openai-streaming-iterator.ts:140