Beignet API reference
    Preparing search index...

    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

    Hierarchy (View Summary)

    Index

    Properties

    Channel handlers that deliver the notification.

    description?: string

    Optional human-readable description for docs and tooling.

    kind: "notification"

    Discriminator for notification definitions.

    name: Name

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

    payload: Payload

    Standard Schema payload validator.