CustomEvent

Defined in: packages/ai/src/types.ts:1745

Custom event for extensibility.

@ag-ui/core provides: name, value, subagentRunId?

Extends#

• Omit<AGUICustomEvent, "type">

Extended by#

• StructuredOutputCompleteEvent
• StructuredOutputStartEvent
• ApprovalRequestedEvent
• ToolInputAvailableEvent
• UIResourceEvent
• SandboxFileCustomEvent
• SandboxFileDiffEvent
• FileChangedEvent
• SessionIdEvent
• CodeModeExecutionStartedEvent
• CodeModeConsoleEvent
• CodeModeExternalCallEvent
• CodeModeExternalResultEvent
• CodeModeExternalErrorEvent
• CodeModeSnippetCallEvent
• CodeModeSnippetResultEvent
• CodeModeSnippetErrorEvent
• SnippetRegisteredEvent

Properties#

metadata?#

optional metadata?: Record<string, any>;

Defined in: packages/ai/src/types.ts:1747

Extra information attached to this event.

Overrides#

Omit.metadata

type#

type: "CUSTOM";

Defined in: packages/ai/src/types.ts:1746