Interface EnumTupleVariantTypeNode<TTuple, TDisplay>

A variant of an enum that carries a tuple payload (positional fields).

interface EnumTupleVariantTypeNode<
    TTuple extends
        NestedTypeNode<TupleTypeNode> = NestedTypeNode<TupleTypeNode>,
    TDisplay extends
        EnumVariantDisplayNode
        | undefined = EnumVariantDisplayNode | undefined,
> {
    discriminator?: number;
    display?: TDisplay;
    kind: "enumTupleVariantTypeNode";
    name: CamelCaseString;
    tuple: TTuple;
}

Type Parameters

TTuple extends NestedTypeNode<TupleTypeNode> = NestedTypeNode<TupleTypeNode>
TDisplay extends EnumVariantDisplayNode | undefined = EnumVariantDisplayNode | undefined

Index

Properties

discriminator? display? kind name tuple

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: "enumTupleVariantTypeNode"

`Readonly`name

name: CamelCaseString

The name of the variant.

`Readonly`tuple

tuple: TTuple

The tuple of positional fields carried by the variant.