Interface EnumValueNode<TEnum, TValue>

A concrete value of a defined enum: a variant identifier plus an optional payload.

interface EnumValueNode<
    TEnum extends DefinedTypeLinkNode = DefinedTypeLinkNode,
    TValue extends EnumValuePayload | undefined = EnumValuePayload | undefined,
> {
    enum: TEnum;
    kind: "enumValueNode";
    value?: TValue;
    variant: CamelCaseString;
}

Type Parameters

TEnum extends DefinedTypeLinkNode = DefinedTypeLinkNode
TValue extends EnumValuePayload | undefined = EnumValuePayload | undefined

Index

Properties

enum kind value? variant

Properties

`Readonly`enum

enum: TEnum

A link to the defined enum type the value belongs to.

`Readonly`kind

kind: "enumValueNode"

`Optional` `Readonly`value

value?: TValue

The variant payload — a struct value for struct variants or a tuple value for tuple variants. Omitted for unit variants.

`Readonly`variant

variant: CamelCaseString

The name of the selected variant.