Interface IFormatBalanceOptions

interface IFormatBalanceOptions {
    decimals?: number;
    forceUnit?: string;
    unit?: string;
    withSi?: boolean;
    withSiFull?: boolean;
    withUnit?: string | boolean;
}

Properties

decimals? forceUnit? unit? withSi? withSiFull? withUnit?

Properties

Optional decimals

decimals?: number

Description

The number of decimals.

Optional forceUnit

forceUnit?: string

Description

Format the number with this specific unit.

Optional unit

unit?: string

Description

Token Unit.

Optional withSi

withSi?: boolean

Description

Format with SI, i.e. m/M/etc.

Optional withSiFull

withSiFull?: boolean

Description

Format with full SI, i.e. mili/Mega/etc.

Optional withUnit

withUnit?: string | boolean

Description

Add the unit (useful in Balance formats).

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc