Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
Class References
Function References
Interface References
Type Alias References
Variable References

CustomEvent

Interface: CustomEvent

Defined in: types.ts:944

Custom event for extensibility.

Extends

Properties

model?

ts
optional model: string;
optional model: string;

Defined in: types.ts:756

Model identifier for multi-model support

Inherited from

BaseAGUIEvent.model


name

ts
name: string;
name: string;

Defined in: types.ts:947

Custom event name


rawEvent?

ts
optional rawEvent: unknown;
optional rawEvent: unknown;

Defined in: types.ts:758

Original provider event for debugging/advanced use cases

Inherited from

BaseAGUIEvent.rawEvent


timestamp

ts
timestamp: number;
timestamp: number;

Defined in: types.ts:754

Inherited from

BaseAGUIEvent.timestamp


type

ts
type: "CUSTOM";
type: "CUSTOM";

Defined in: types.ts:945

Overrides

BaseAGUIEvent.type


value?

ts
optional value: unknown;
optional value: unknown;

Defined in: types.ts:949

Custom event value