Type alias NumberFormatConfig

NumberFormatConfig: object

Configuration for number formatting.

Type declaration

billion?: boolean

Boolean flag whether to show an abbreviation for a number greater than or equal one billion - e.g. 1B

decimalScale?: DecimalScale

The number of decimal places

kilo?: boolean

Boolean flag whether to show an abbreviation for a number greater than or equal one thousand - e.g. 1K

million?: boolean

Boolean flag whether to show an abbreviation for a number greater than or equal one million - e.g. 1M

name?: "Currency" | "Numbers" | "Percent"

Supported formats

prefix?: boolean

Boolean flag whether symbol is shown in front of or after the number

If true, append symbol in front of the number, e.g. show $1000 when symbol is $.

If false, append symbol after the number, e.g. show 1000¥ when symbol is ¥.

symbol?: string

Symbol to show in front of or after the number depending on the value of prefix.

thousandSeparator?: boolean

Boolean flag whether the thousand separator is shown

If true, show the thousand separator, e.g. 1,000. Otherwise, show 1000

trillion?: boolean

Boolean flag whether to show an abbreviation for a number greater than or equal one trillion - e.g. 1T