Open History to see the last commit
1---
2id: StreamProcessorEvents
3title: StreamProcessorEvents
4---
5
6# Interface: StreamProcessorEvents
7
8Defined in: [packages/ai/src/activities/chat/stream/processor.ts:67](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L67)
9
10Events emitted by the StreamProcessor
11
12## Properties
13
14### onApprovalRequest()?
15
16```ts
17optional onApprovalRequest: (args) => void;
18```
19
20Defined in: [packages/ai/src/activities/chat/stream/processor.ts:82](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L82)
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### onCustomEvent()?
49
50```ts
51optional onCustomEvent: (eventType, data, context) => void;
52```
53
54Defined in: [packages/ai/src/activities/chat/stream/processor.ts:90](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L90)
55
56#### Parameters
57
58##### eventType
59
60`string`
61
62##### data
63
64`unknown`
65
66##### context
67
68###### toolCallId?
69
70`string`
71
72#### Returns
73
74`void`
75
76***
77
78### onError()?
79
80```ts
81optional onError: (error) => void;
82```
83
84Defined in: [packages/ai/src/activities/chat/stream/processor.ts:74](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L74)
85
86#### Parameters
87
88##### error
89
90`Error`
91
92#### Returns
93
94`void`
95
96***
97
98### onMessagesChange()?
99
100```ts
101optional onMessagesChange: (messages) => void;
102```
103
104Defined in: [packages/ai/src/activities/chat/stream/processor.ts:69](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L69)
105
106#### Parameters
107
108##### messages
109
110[`UIMessage`](UIMessage.md)\<`unknown`\>[]
111
112#### Returns
113
114`void`
115
116***
117
118### onStreamEnd()?
119
120```ts
121optional onStreamEnd: (message) => void;
122```
123
124Defined in: [packages/ai/src/activities/chat/stream/processor.ts:73](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L73)
125
126#### Parameters
127
128##### message
129
130[`UIMessage`](UIMessage.md)
131
132#### Returns
133
134`void`
135
136***
137
138### onStreamStart()?
139
140```ts
141optional onStreamStart: () => void;
142```
143
144Defined in: [packages/ai/src/activities/chat/stream/processor.ts:72](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L72)
145
146#### Returns
147
148`void`
149
150***
151
152### onStructuredOutputChange()?
153
154```ts
155optional onStructuredOutputChange: (args) => void;
156```
157
158Defined in: [packages/ai/src/activities/chat/stream/processor.ts:109](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L109)
159
160#### Parameters
161
162##### args
163
164###### data?
165
166`unknown`
167
168###### delta?
169
170`string`
171
172###### errorMessage?
173
174`string`
175
176###### messageId
177
178`string`
179
180###### partial?
181
182`unknown`
183
184###### phase
185
186`"error"` \| `"complete"` \| `"start"` \| `"update"`
187
188###### raw
189
190`string`
191
192###### reasoning?
193
194`string`
195
196###### status
197
198`"error"` \| `"complete"` \| `"streaming"`
199
200#### Returns
201
202`void`
203
204***
205
206### onTextUpdate()?
207
208```ts
209optional onTextUpdate: (messageId, content) => void;
210```
211
212Defined in: [packages/ai/src/activities/chat/stream/processor.ts:97](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L97)
213
214#### Parameters
215
216##### messageId
217
218`string`
219
220##### content
221
222`string`
223
224#### Returns
225
226`void`
227
228***
229
230### onThinkingUpdate()?
231
232```ts
233optional onThinkingUpdate: (messageId, stepId, content) => void;
234```
235
236Defined in: [packages/ai/src/activities/chat/stream/processor.ts:104](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L104)
237
238#### Parameters
239
240##### messageId
241
242`string`
243
244##### stepId
245
246`string`
247
248##### content
249
250`string`
251
252#### Returns
253
254`void`
255
256***
257
258### onToolCall()?
259
260```ts
261optional onToolCall: (args) => void;
262```
263
264Defined in: [packages/ai/src/activities/chat/stream/processor.ts:77](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L77)
265
266#### Parameters
267
268##### args
269
270###### input
271
272`any`
273
274###### toolCallId
275
276`string`
277
278###### toolName
279
280`string`
281
282#### Returns
283
284`void`
285
286***
287
288### onToolCallStateChange()?
289
290```ts
291optional onToolCallStateChange: (messageId, toolCallId, state, args) => void;
292```
293
294Defined in: [packages/ai/src/activities/chat/stream/processor.ts:98](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L98)
295
296#### Parameters
297
298##### messageId
299
300`string`
301
302##### toolCallId
303
304`string`
305
306##### state
307
308[`ToolCallState`](../type-aliases/ToolCallState.md)
309
310##### args
311
312`string`
313
314#### Returns
315
316`void`