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

CustomEvent.md

42 lines892 Bytes

1---
2id: CustomEvent
3title: CustomEvent
4---
5​
6# Interface: CustomEvent
7​
8Defined in: [packages/typescript/ai/src/types.ts:1145](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1145)
9​
10Custom event for extensibility.
11​
12@ag-ui/core provides: `name`, `value`
13TanStack AI adds: `model?`
14​
15## Extends
16​
17- `CustomEvent`
18​
19## Extended by
20​
21- [`StructuredOutputCompleteEvent`](StructuredOutputCompleteEvent.md)
22- [`StructuredOutputStartEvent`](StructuredOutputStartEvent.md)
23- [`ApprovalRequestedEvent`](ApprovalRequestedEvent.md)
24- [`ToolInputAvailableEvent`](ToolInputAvailableEvent.md)
25​
26## Indexable
27​
28```ts
29[k: string]: unknown
30```
31​
32## Properties
33​
34### model?
35​
36```ts
37optional model: string;
38```
39​
40Defined in: [packages/typescript/ai/src/types.ts:1147](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1147)
41​
42Model identifier for multi-model support