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

StreamProcessorEvents.md

228 lines3.4 KB

1---
2id: StreamProcessorEvents
3title: StreamProcessorEvents
4---
5​
6# Interface: StreamProcessorEvents
7​
8Defined in: [activities/chat/stream/processor.ts:48](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L48)
9​
10Events emitted by the StreamProcessor
11​
12## Properties
13​
14### onApprovalRequest()?
15​
16```ts
17optional onApprovalRequest: (args) => void;
18```
19​
20Defined in: [activities/chat/stream/processor.ts:63](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L63)
21​
22#### Parameters
23​
24##### args
25​
26###### approvalId
27​
28`string`
29​
30###### input
31​
32`any`
33​
34###### toolCallId
35​
36`string`
37​
38###### toolName
39​
40`string`
41​
42#### Returns
43​
44`void`
45​
46***
47​
48### onError()?
49​
50```ts
51optional onError: (error) => void;
52```
53​
54Defined in: [activities/chat/stream/processor.ts:55](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L55)
55​
56#### Parameters
57​
58##### error
59​
60`Error`
61​
62#### Returns
63​
64`void`
65​
66***
67​
68### onMessagesChange()?
69​
70```ts
71optional onMessagesChange: (messages) => void;
72```
73​
74Defined in: [activities/chat/stream/processor.ts:50](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L50)
75​
76#### Parameters
77​
78##### messages
79​
80[`UIMessage`](UIMessage.md)[]
81​
82#### Returns
83​
84`void`
85​
86***
87​
88### onStreamEnd()?
89​
90```ts
91optional onStreamEnd: (message) => void;
92```
93​
94Defined in: [activities/chat/stream/processor.ts:54](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L54)
95​
96#### Parameters
97​
98##### message
99​
100[`UIMessage`](UIMessage.md)
101​
102#### Returns
103​
104`void`
105​
106***
107​
108### onStreamStart()?
109​
110```ts
111optional onStreamStart: () => void;
112```
113​
114Defined in: [activities/chat/stream/processor.ts:53](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L53)
115​
116#### Returns
117​
118`void`
119​
120***
121​
122### onTextUpdate()?
123​
124```ts
125optional onTextUpdate: (messageId, content) => void;
126```
127​
128Defined in: [activities/chat/stream/processor.ts:71](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L71)
129​
130#### Parameters
131​
132##### messageId
133​
134`string`
135​
136##### content
137​
138`string`
139​
140#### Returns
141​
142`void`
143​
144***
145​
146### onThinkingUpdate()?
147​
148```ts
149optional onThinkingUpdate: (messageId, content) => void;
150```
151​
152Defined in: [activities/chat/stream/processor.ts:78](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L78)
153​
154#### Parameters
155​
156##### messageId
157​
158`string`
159​
160##### content
161​
162`string`
163​
164#### Returns
165​
166`void`
167​
168***
169​
170### onToolCall()?
171​
172```ts
173optional onToolCall: (args) => void;
174```
175​
176Defined in: [activities/chat/stream/processor.ts:58](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L58)
177​
178#### Parameters
179​
180##### args
181​
182###### input
183​
184`any`
185​
186###### toolCallId
187​
188`string`
189​
190###### toolName
191​
192`string`
193​
194#### Returns
195​
196`void`
197​
198***
199​
200### onToolCallStateChange()?
201​
202```ts
203optional onToolCallStateChange: (messageId, toolCallId, state, args) => void;
204```
205​
206Defined in: [activities/chat/stream/processor.ts:72](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L72)
207​
208#### Parameters
209​
210##### messageId
211​
212`string`
213​
214##### toolCallId
215​
216`string`
217​
218##### state
219​
220[`ToolCallState`](../type-aliases/ToolCallState.md)
221​
222##### args
223​
224`string`
225​
226#### Returns
227​
228`void`