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

StreamProcessorEvents.md

262 lines4.1 KB

Interface: StreamProcessorEvents

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

Events emitted by the StreamProcessor

Properties

onApprovalRequest()?

optional onApprovalRequest: (args) => void;

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

Parameters

args
approvalId

string

input

any

toolCallId

string

toolName

string

Returns

void


onCustomEvent()?

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

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

Parameters

eventType

string

data

unknown

context
toolCallId?

string

Returns

void


onError()?

optional onError: (error) => void;

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

Parameters

error

Error

Returns

void


onMessagesChange()?

optional onMessagesChange: (messages) => void;

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

Parameters

messages

UIMessage<unknown>[]

Returns

void


onStreamEnd()?

optional onStreamEnd: (message) => void;

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

Parameters

message

UIMessage

Returns

void


onStreamStart()?

optional onStreamStart: () => void;

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

Returns

void


onTextUpdate()?

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

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

Parameters

messageId

string

content

string

Returns

void


onThinkingUpdate()?

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

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

Parameters

messageId

string

stepId

string

content

string

Returns

void


onToolCall()?

optional onToolCall: (args) => void;

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

Parameters

args
input

any

toolCallId

string

toolName

string

Returns

void


onToolCallStateChange()?

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

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

Parameters

messageId

string

toolCallId

string

state

ToolCallState

args

string

Returns

void