Interface EnumStructVariantTypeNode<TStruct, TDisplay>

A variant of an enum that carries a struct payload (named fields).

interface EnumStructVariantTypeNode<
    TStruct extends
        NestedTypeNode<StructTypeNode> = NestedTypeNode<StructTypeNode>,
    TDisplay extends
        EnumVariantDisplayNode
        | undefined = EnumVariantDisplayNode | undefined,
> {
    discriminator?: number;
    display?: TDisplay;
    kind: "enumStructVariantTypeNode";
    name: CamelCaseString;
    struct: TStruct;
}

Type Parameters

TStruct extends NestedTypeNode<StructTypeNode> = NestedTypeNode<StructTypeNode>
TDisplay extends EnumVariantDisplayNode | undefined = EnumVariantDisplayNode | undefined

Index

Properties

discriminator? display? kind name struct

Properties

`Optional` `Readonly`discriminator

discriminator?: number

Explicit discriminator value. When omitted, the discriminator is the index of the variant in the enum, starting at 0.

`Optional` `Readonly`display

display?: TDisplay

Display metadata describing how the variant is presented.

`Readonly`kind

kind: "enumStructVariantTypeNode"

`Readonly`name

name: CamelCaseString

The name of the variant.

`Readonly`struct

struct: TStruct

The struct of named fields carried by the variant.