Interface EventNode<TData, TDiscriminators>

A program event: its data shape and optional discriminators used to identify it on the wire.

interface EventNode<
    TData extends TypeNode = TypeNode,
    TDiscriminators extends
        DiscriminatorNode[] | undefined = DiscriminatorNode[] | undefined,
> {
    data: TData;
    discriminators?: TDiscriminators;
    docs?: Docs;
    kind: "eventNode";
    name: CamelCaseString;
}

Type Parameters

TData extends TypeNode = TypeNode
TDiscriminators extends DiscriminatorNode[] | undefined = DiscriminatorNode[] | undefined

Index

Properties

data discriminators? docs? kind name

Properties

`Readonly`data

data: TData

The type describing the event payload.

`Optional` `Readonly`discriminators

discriminators?: TDiscriminators

Discriminators that distinguish this event from others. When multiple are listed, they are combined with a logical AND.

`Optional` `Readonly`docs

docs?: Docs

Markdown documentation for the event.

`Readonly`kind

kind: "eventNode"

`Readonly`name

name: CamelCaseString

The name of the event.