Skip to main content

Class: ChatRun<T>

Defined in: packages/client/src/run.ts:9

One turn in flight. Iterate it for events, or await text(), object() or result(). Every iterator replays the events from the start, so late consumers miss nothing.

Type Parameters​

T​

T = unknown

Implements​

Constructors​

Constructor​

new ChatRun<T>(turnId, executor, signal?): ChatRun<T>

Defined in: packages/client/src/run.ts:17

Parameters​

turnId​

string

executor​

(emit, signal) => Promise<ChatResult<T>>

signal?​

AbortSignal

Returns​

ChatRun<T>

Properties​

turnId​

readonly turnId: string

Defined in: packages/client/src/run.ts:18

Accessors​

finished​

Get Signature​

get finished(): boolean

Defined in: packages/client/src/run.ts:53

Returns​

boolean

signal​

Get Signature​

get signal(): AbortSignal

Defined in: packages/client/src/run.ts:49

Returns​

AbortSignal

Methods​

[asyncIterator]()​

[asyncIterator](): AsyncIterator<ChatEvent>

Defined in: packages/client/src/run.ts:80

Returns​

AsyncIterator<ChatEvent>

Implementation of​

AsyncIterable.[asyncIterator]

abort()​

abort(reason?): void

Defined in: packages/client/src/run.ts:45

Cancel the turn.

Parameters​

reason?​

unknown

Returns​

void

object()​

object(): Promise<T>

Defined in: packages/client/src/run.ts:74

The structured output. Rejects when the request had no schema.

Returns​

Promise<T>

on()​

on(listener): () => void

Defined in: packages/client/src/run.ts:58

Call listener for every event, past and future. Returns the unsubscribe function.

Parameters​

listener​

(event) => void

Returns​

() => void

result()​

result(): Promise<ChatResult<T>>

Defined in: packages/client/src/run.ts:65

Returns​

Promise<ChatResult<T>>

text()​

text(): Promise<string>

Defined in: packages/client/src/run.ts:69

Returns​

Promise<string>