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

CustomEvent.md

56 lines1.6 KB

1---
2id: CustomEvent
3title: CustomEvent
4---
5​
6# Interface: CustomEvent
7​
8Defined in: [packages/ai/src/types.ts:1337](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1337)
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- [`UIResourceEvent`](UIResourceEvent.md)
26- [`SandboxFileCustomEvent`](SandboxFileCustomEvent.md)
27- [`SandboxFileDiffEvent`](SandboxFileDiffEvent.md)
28- [`FileChangedEvent`](FileChangedEvent.md)
29- [`SessionIdEvent`](SessionIdEvent.md)
30- [`CodeModeExecutionStartedEvent`](CodeModeExecutionStartedEvent.md)
31- [`CodeModeConsoleEvent`](CodeModeConsoleEvent.md)
32- [`CodeModeExternalCallEvent`](CodeModeExternalCallEvent.md)
33- [`CodeModeExternalResultEvent`](CodeModeExternalResultEvent.md)
34- [`CodeModeExternalErrorEvent`](CodeModeExternalErrorEvent.md)
35- [`CodeModeSkillCallEvent`](CodeModeSkillCallEvent.md)
36- [`CodeModeSkillResultEvent`](CodeModeSkillResultEvent.md)
37- [`CodeModeSkillErrorEvent`](CodeModeSkillErrorEvent.md)
38- [`SkillRegisteredEvent`](SkillRegisteredEvent.md)
39​
40## Indexable
41​
42```ts
43[k: string]: unknown
44```
45​
46## Properties
47​
48### model?
49​
50```ts
51optional model: string;
52```
53​
54Defined in: [packages/ai/src/types.ts:1339](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1339)
55​
56Model identifier for multi-model support