Interface NotificationPayloadDef<Name, Payload>

Minimal notification definition shape accepted by notification ports.

interface NotificationPayloadDef<
    Name extends string = string,
    Payload extends StandardSchema = StandardSchema,
> {
    description?: string;
    name: Name;
    payload: Payload;
}

Type Parameters

Name extends string = string
Payload extends StandardSchema = StandardSchema

Hierarchy (View Summary)

NotificationPayloadDef
- NotificationDef

Index

Properties

description? name payload

Properties

`Optional` `Readonly`description

description?: string

Optional human-readable description for docs and tooling.

`Readonly`name

name: Name

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

`Readonly`payload

payload: Payload

Standard Schema payload validator.