Skip to main content

StreamingMessageOptions

Agent Runtimes

Agent Runtimes / types/messages / StreamingMessageOptions

Interface: StreamingMessageOptions

Defined in: src/types/messages.ts:102

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

Properties​

onChunk?​

optional onChunk?: (chunk) => void

Defined in: src/types/messages.ts:104

Callback for each chunk of streamed content

Parameters​

chunk​

string

Returns​

void

onComplete?​

optional onComplete?: (fullResponse) => void

Defined in: src/types/messages.ts:106

Callback when streaming is complete

Parameters​

fullResponse​

string

Returns​

void

onError?​

optional onError?: (error) => void

Defined in: src/types/messages.ts:108

Callback on error

Parameters​

error​

Error

Returns​

void

signal?​

optional signal?: AbortSignal

Defined in: src/types/messages.ts:110

Abort signal for cancellation