Skip to main content

StreamingMessageOptions

Agent Runtimes


Agent Runtimes / types/messages / StreamingMessageOptions

Interface: StreamingMessageOptions

Defined in: types/messages.ts:106

Streaming options for custom message handlers. Enables streaming response support with chunk callbacks.

Properties

onChunk?

optional onChunk?: (chunk) => void

Defined in: types/messages.ts:108

Callback for each chunk of streamed content

Parameters

chunk

string

Returns

void


onComplete?

optional onComplete?: (fullResponse) => void

Defined in: types/messages.ts:110

Callback when streaming is complete

Parameters

fullResponse

string

Returns

void


onError?

optional onError?: (error) => void

Defined in: types/messages.ts:112

Callback on error

Parameters

error

Error

Returns

void


signal?

optional signal?: AbortSignal

Defined in: types/messages.ts:114

Abort signal for cancellation