Function amountTypeNode

amountTypeNode<
    const TNumber extends
        NestedTypeNode<
            NumberTypeNode<NumberFormat, NumberDisplayNode | undefined>,
        >,
>(
    number: TNumber,
    decimals: number,
    unit?: string,
): AmountTypeNode<TNumber>
Wraps a number type to provide additional context such as decimal places and a unit. Useful for amounts representing financial values.
Type Parameters
- const TNumber extends NestedTypeNode<NumberTypeNode<NumberFormat, NumberDisplayNode | undefined>>
Parameters
- number: TNumber
- decimals: number
- Optionalunit: string
Returns AmountTypeNode<TNumber>
- Defined in node_modules/@codama/nodes/dist/types/generated/typeNodes/AmountTypeNode.d.ts:6