NumberFormatOptions

external interface NumberFormatOptions

Options for Intl.NumberFormat

Documentation by Mozilla Contributors is licensed under CC-BY-SA 2.5.

Properties

Link copied to clipboard
abstract var compactDisplay: String

Only used when notation is "compact". Takes either "short" (default) or "long".

Link copied to clipboard
abstract var currency: String

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.

Link copied to clipboard
abstract var currencyDisplay: String

How to display the currency in currency formatting. Possible values are:

Link copied to clipboard
abstract var currencySign: String

In many locales, accounting format means to wrap the number with parentheses instead of appending a minus sign. You can enable this formatting by setting the currencySign option to "accounting". The default value is "standard".

Link copied to clipboard
abstract var localeMatcher: String

The locale matching algorithm to use. Possible values are "lookup" and "best fit"; the default is "best fit". For information about this option, see the Intl page.

Link copied to clipboard

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 code list (2 if the list doesn't provide that information); the default for percent formatting is the larger of minimumFractionDigits and 0.

Link copied to clipboard

The maximum number of significant digits to use. Possible values are from 1 to 21; the default is 21.

Link copied to clipboard

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 code list (2 if the list doesn't provide that information).

Link copied to clipboard

The minimum number of integer digits to use. Possible values are from 1 to 21; the default is 1.

Link copied to clipboard

The minimum number of significant digits to use. Possible values are from 1 to 21; the default is 1.

Link copied to clipboard
abstract var notation: String

The formatting that should be displayed for the number, the defaults is "standard"

Link copied to clipboard
abstract var numberingSystem: String

Numbering System. Possible values include: "arab", "arabext", " bali", "beng", "deva", "fullwide", " gujr", "guru", "hanidec", "khmr", " knda", "laoo", "latn", "limb", "mlym", " mong", "mymr", "orya", "tamldec", " telu", "thai", "tibt".

Link copied to clipboard
abstract var signDisplay: String

When to display the sign for the number; defaults to "auto"

Link copied to clipboard
abstract var style: String

The formatting style to use , the default is "decimal".

Link copied to clipboard
abstract var unit: String

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.

Link copied to clipboard
abstract var unitDisplay: String

The unit formatting style to use in unit formatting, the defaults is "short".

Link copied to clipboard
abstract var useGrouping: Boolean

Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators. Possible values are true and false; the default is true.