0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces/StreamProcessorEvents.md
github-actions[bot] 1999af2267
docs: regenerate API documentation (#1260)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-28 11:42:19 +02:00

4.5 KiB

id title
StreamProcessorEvents StreamProcessorEvents

Interface: StreamProcessorEvents

Defined in: packages/ai/src/activities/chat/stream/processor.ts:78

Events emitted by the StreamProcessor

Properties

onApprovalRequest?

optional onApprovalRequest?: (args) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:93

Parameters

args
approvalId

string

input

any

toolCallId

string

toolName

string

Returns

void


onCustomEvent?

optional onCustomEvent?: (eventType, data, context) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:101

Parameters

eventType

string

data

unknown

context
toolCallId?

string

Returns

void


onError?

optional onError?: (error) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:85

Parameters

error

Error

Returns

void


onMessagesChange?

optional onMessagesChange?: (messages) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:80

Parameters

messages

UIMessage<unknown>[]

Returns

void


onStreamEnd?

optional onStreamEnd?: (message) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:84

Parameters

message

UIMessage

Returns

void


onStreamStart?

optional onStreamStart?: () => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:83

Returns

void


onStructuredOutputChange?

optional onStructuredOutputChange?: (args) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:120

Parameters

args
data?

unknown

delta?

string

errorMessage?

string

messageId

string

partial?

unknown

phase

"error" | "complete" | "start" | "update"

raw

string

reasoning?

string

status

"error" | "complete" | "streaming"

Returns

void


onTextUpdate?

optional onTextUpdate?: (messageId, content) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:108

Parameters

messageId

string

content

string

Returns

void


onThinkingUpdate?

optional onThinkingUpdate?: (messageId, stepId, content) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:115

Parameters

messageId

string

stepId

string

content

string

Returns

void


onToolCall?

optional onToolCall?: (args) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:88

Parameters

args
input

any

toolCallId

string

toolName

string

Returns

void


onToolCallStateChange?

optional onToolCallStateChange?: (messageId, toolCallId, state, args) => void;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:109

Parameters

messageId

string

toolCallId

string

state

ToolCallState

args

string

Returns

void