Interface AmountTypeNode<TNumber>

Wraps a number type to provide additional context such as decimal places and a unit. Useful for amounts representing financial values.

interface AmountTypeNode<
    TNumber extends
        NestedTypeNode<NumberTypeNode> = NestedTypeNode<NumberTypeNode>,
> {
    decimals: number;
    kind: "amountTypeNode";
    number: TNumber;
    unit?: string;
}

Type Parameters

TNumber extends NestedTypeNode<NumberTypeNode> = NestedTypeNode<NumberTypeNode>

Index

Properties

decimals kind number unit?

Properties

`Readonly`decimals

decimals: number

The number of decimal places the wrapped integer carries. For example, an integer value of 12345 with 2 decimal places represents 123.45.

`Readonly`kind

kind: "amountTypeNode"

`Readonly`number

number: TNumber

The number type the amount wraps.

`Optional` `Readonly`unit

unit?: string

The unit of the amount — e.g. "USD" or "%".