Interface NotificationDef<Name, Payload, Ctx>

Notification definition created by defineNotification(...).

interface NotificationDef<
    Name extends string = string,
    Payload extends StandardSchema = StandardSchema,
    Ctx = unknown,
> {
    channels: NotificationChannels<Payload, Ctx>;
    description?: string;
    kind: "notification";
    name: Name;
    payload: Payload;
}

Type Parameters

Name extends string = string
Payload extends StandardSchema = StandardSchema
Ctx = unknown

Hierarchy (View Summary)

NotificationPayloadDef<Name, Payload>
- NotificationDef

Index

Properties

channels description? kind name payload

Properties

`Readonly`channels

channels: NotificationChannels<Payload, Ctx>

Channel handlers that deliver the notification.

`Optional` `Readonly`description

description?: string

Optional human-readable description for docs and tooling.

`Readonly`kind

kind: "notification"

Discriminator for notification definitions.

`Readonly`name

name: Name

Stable notification name used by dispatchers, tests, and tooling.

`Readonly`payload

payload: Payload

Standard Schema payload validator.