Interface Unit

A currency unit.

interface Unit {
    format(i: bigint): string;
    fromNumber(n: number): bigint;
    toNumber(i: bigint): number;
    unitId(): string;
}

Index

Methods

format fromNumber toNumber unitId

Methods

format

format(i: bigint): string
Format this currency into the canonical string repr.
Parameters
- i: bigint
Returns string
- Defined in types.ts:111

fromNumber

fromNumber(n: number): bigint
Load this currency from the canonical number repr.
Parameters
- n: number
Returns bigint
- Defined in types.ts:101

toNumber

toNumber(i: bigint): number
Extract the canonical number repr for a currency value.
Parameters
- i: bigint
Returns number
- Defined in types.ts:106

unitId

unitId(): string
The currency identifier.

Returns string
- Defined in types.ts:96