Intl.PluralRules.prototype.resolvedOptions()
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2019.
The resolvedOptions()
method of Intl.PluralRules
instances returns a new object with properties reflecting the locale and plural formatting options computed during initialization of this Intl.PluralRules
object.
Try it
Syntax
resolvedOptions()
Parameters
None.
Return value
A new object with properties reflecting the locale and plural formatting options computed during the initialization of the given Intl.PluralRules
object.
The object has the following properties:
locale
-
The BCP 47 language tag for the locale actually used. If any Unicode extension values were requested in the input BCP 47 language tag that led to this locale, the key-value pairs that were requested and are supported for this locale are included in
locale
. pluralCategories
-
An
Array
of plural categories used by the given locale, selected from the list"zero"
,"one"
,"two"
,"few"
,"many"
and"other"
. type
-
The type used (
cardinal
orordinal
). roundingIncrement
Experimental-
The rounding-increment precision (the increment used when rounding numbers). This is the value specified in the
options.roundingIncrement
argument in the constructor. roundingMode
Experimental-
The rounding mode. This is the value provided for the
options.roundingMode
argument in the constructor, or the default value:halfExpand
. roundingPriority
Experimental-
The priority for resolving rounding conflicts if both "FractionDigits" and "SignificantDigits" are specified. This is the value provided for the
options.roundingPriority
argument in the constructor, or the default value:auto
. trailingZeroDisplay
Experimental-
The strategy for displaying trailing zeros on whole numbers. This is the value specified in the
options.trailingZeroDisplay
argument in the constructor, or the default value:"auto"
.
Only one of the following two groups of properties is included:
minimumIntegerDigits
,minimumFractionDigits
,maximumFractionDigits
-
The values provided for these properties in the
options
argument or filled in as defaults. These properties are present only if neitherminimumSignificantDigits
normaximumSignificantDigits
was provided in theoptions
argument. minimumSignificantDigits
,maximumSignificantDigits
-
The values provided for these properties in the
options
argument or filled in as defaults. These properties are present only if at least one of them was provided in theoptions
argument.
Examples
Using the resolvedOptions() method
The code below shows the construction of a PluralRules
object, followed by logging of each of the resolved options.
// Create a PluralRules instance
const de = new Intl.PluralRules("de-DE", {
maximumSignificantDigits: 2,
trailingZeroDisplay: "auto",
});
// Resolve the options
const usedOptions = de.resolvedOptions();
console.log(usedOptions.locale); // "de-DE"
console.log(usedOptions.pluralCategories); // Array ["one", "other"]
console.log(usedOptions.type); // "cardinal"
console.log(usedOptions.minimumIntegerDigits); // 1
console.log(usedOptions.minimumFractionDigits); // undefined (maximumSignificantDigits is set)
console.log(usedOptions.maximumFractionDigits); //undefined (maximumSignificantDigits is set)
console.log(usedOptions.minimumSignificantDigits); // 1
console.log(usedOptions.maximumSignificantDigits); //2
console.log(usedOptions.roundingIncrement); // 1
console.log(usedOptions.roundingMode); // "halfExpand"
console.log(usedOptions.roundingPriority); // "auto"
console.log(usedOptions.trailingZeroDisplay); // "auto"
Specifications
Specification |
---|
ECMAScript Internationalization API Specification # sec-intl.pluralrules.prototype.resolvedoptions |
Browser compatibility
BCD tables only load in the browser