Interface OptionTypeNode<TItem, TPrefix>

A value that may be present or absent (Some/None), with an explicit numeric prefix indicating presence.

interface OptionTypeNode<
    TItem extends TypeNode = TypeNode,
    TPrefix extends
        NestedTypeNode<NumberTypeNode> = NestedTypeNode<NumberTypeNode>,
> {
    fixed?: boolean;
    item: TItem;
    kind: "optionTypeNode";
    prefix: TPrefix;
}

Type Parameters

TItem extends TypeNode = TypeNode
TPrefix extends NestedTypeNode<NumberTypeNode> = NestedTypeNode<NumberTypeNode>

Index

Properties

fixed? item kind prefix

Properties

`Optional` `Readonly`fixed

fixed?: boolean

When true, the absent variant still occupies the byte size of the present variant (zero-padded). Defaults to false.

`Readonly`item

item: TItem

The type carried by the option when present.

`Readonly`kind

kind: "optionTypeNode"

`Readonly`prefix

prefix: TPrefix

The numeric type used as the presence flag.