Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

StreamProcessorEvents.md

228 lines3.4 KB

Interface: StreamProcessorEvents

Defined in: activities/chat/stream/processor.ts:48

Events emitted by the StreamProcessor

Properties

onApprovalRequest()?

optional onApprovalRequest: (args) => void;

Defined in: activities/chat/stream/processor.ts:63

Parameters

args
approvalId

string

input

any

toolCallId

string

toolName

string

Returns

void


onError()?

optional onError: (error) => void;

Defined in: activities/chat/stream/processor.ts:55

Parameters

error

Error

Returns

void


onMessagesChange()?

optional onMessagesChange: (messages) => void;

Defined in: activities/chat/stream/processor.ts:50

Parameters

messages

UIMessage[]

Returns

void


onStreamEnd()?

optional onStreamEnd: (message) => void;

Defined in: activities/chat/stream/processor.ts:54

Parameters

message

UIMessage

Returns

void


onStreamStart()?

optional onStreamStart: () => void;

Defined in: activities/chat/stream/processor.ts:53

Returns

void


onTextUpdate()?

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

Defined in: activities/chat/stream/processor.ts:71

Parameters

messageId

string

content

string

Returns

void


onThinkingUpdate()?

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

Defined in: activities/chat/stream/processor.ts:78

Parameters

messageId

string

content

string

Returns

void


onToolCall()?

optional onToolCall: (args) => void;

Defined in: activities/chat/stream/processor.ts:58

Parameters

args
input

any

toolCallId

string

toolName

string

Returns

void


onToolCallStateChange()?

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

Defined in: activities/chat/stream/processor.ts:72

Parameters

messageId

string

toolCallId

string

state

ToolCallState

args

string

Returns

void