0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-18 19:34:58 +00:00
ai/docs/reference/interfaces/CustomEvent.md
github-actions[bot] 1999af2267
docs: regenerate API documentation (#1260)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-28 11:42:19 +02:00

1.9 KiB

id title
CustomEvent CustomEvent

Interface: CustomEvent

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

Custom event for extensibility.

@ag-ui/core provides: name, value

Uses Pick (not extends) so the Zod passthrough index signature does not erase discriminant property access on KnownCustomEvent unions.

Extends

  • Pick<AGUICustomEvent, "name" | "value" | "timestamp" | "rawEvent">

Extended by

Properties

metadata?

optional metadata?: Record<string, any>;

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


type

type: "CUSTOM";

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