Interface BigIntToLocaleStringOptions
compactDisplay?: string;
currency?: string;
currencyDisplay?: string;
localeMatcher?: string;
maximumFractionDigits?:
| 0
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
| 10
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20;
maximumSignificantDigits?:
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
| 10
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20
| 21;
minimumFractionDigits?:
| 0
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
| 10
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20;
minimumIntegerDigits?:
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
| 10
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20
| 21;
minimumSignificantDigits?:
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
| 10
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20
| 21;
notation?: string;
numberingSystem?: string;
style?: string;
unit?: string;
unitDisplay?: string;
useGrouping?: boolean;
}
Properties
OptionalcompactDisplay
Optionalcurrency
The currency to use in currency formatting. Possible values are the ISO 4217 currency codes, such as "USD" for the US dollar, "EUR" for the euro, or "CNY" for the Chinese RMB — see the Current currency & funds code list. There is no default value; if the style is "currency", the currency property must be provided. It is only used when [[Style]] has the value "currency".
OptionalcurrencyDisplay
How to display the currency in currency formatting. It is only used when [[Style]] has the value "currency". The default is "symbol".
"symbol" to use a localized currency symbol such as €,
"code" to use the ISO currency code,
"name" to use a localized currency name such as "dollar"
OptionallocaleMatcher
The locale matching algorithm to use.The default is "best fit". For information about this option, see the Intl page.
OptionalmaximumFractionDigits
| 0
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
| 10
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20
The maximum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number formatting is the larger of minimumFractionDigits and 3; the default for currency formatting is the larger of minimumFractionDigits and the number of minor unit digits provided by the ISO 4217 currency codes list (2 if the list doesn't provide that information); the default for percent formatting is the larger of minimumFractionDigits and 0.
OptionalmaximumSignificantDigits
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
| 10
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20
| 21
The maximum number of significant digits to use. Possible values are from 1 to 21; the default is 21.
OptionalminimumFractionDigits
| 0
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
| 10
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20
The minimum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number and percent formatting is 0; the default for currency formatting is the number of minor unit digits provided by the ISO 4217 currency codes list (2 if the list doesn't provide that information).
OptionalminimumIntegerDigits
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
| 10
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20
| 21
The minimum number of integer digits to use. Possible values are from 1 to 21; the default is 1.
OptionalminimumSignificantDigits
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
| 10
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20
| 21
The minimum number of significant digits to use. Possible values are from 1 to 21; the default is 1.
Optionalnotation
The formatting that should be displayed for the number, the defaults is "standard"
"standard" plain number formatting
"scientific" return the order-of-magnitude for formatted number.
"engineering" return the exponent of ten when divisible by three
"compact" string representing exponent, defaults is using the "short" form
OptionalnumberingSystem
Optionalstyle
The formatting style to use , the default is "decimal".
Optionalunit
The unit to use in unit formatting, Possible values are core unit identifiers, defined in UTS #35, Part 2, Section 6. A subset of units from the full list was selected for use in ECMAScript. Pairs of simple units can be concatenated with "-per-" to make a compound unit. There is no default value; if the style is "unit", the unit property must be provided.
OptionalunitDisplay
The unit formatting style to use in unit formatting, the defaults is "short".
OptionaluseGrouping
Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators. The default is true.
used only when notation is "compact"