Interface EventDef<Name, Payload>

Event definition created by defineEvent(...).

interface EventDef<
    Name extends string = string,
    Payload extends StandardSchema = StandardSchema,
> {
    description?: string;
    kind: "event";
    name: Name;
    payload: Payload;
}

Type Parameters

Name extends string = string
Payload extends StandardSchema = StandardSchema

Hierarchy (View Summary)

EventPayloadDef<Name, Payload>
- EventDef

Index

Properties

description? kind name payload

Properties

`Optional` `Readonly`description

description?: string

Optional human-readable description for docs and tooling.

`Readonly`kind

kind: "event"

Discriminator for event definitions.

`Readonly`name

name: Name

Stable event name.

`Readonly`payload

payload: Payload

Standard Schema payload validator.