The Intl.Collator.prototype.resolvedOptions()
method returns a new object with properties reflecting the locale and collation options computed during initialization of this Collator
object.
The source for this interactive example is stored in a GitHub repository. If you'd like to contribute to the interactive examples project, please clone https://github.com/mdn/interactive-examples and send us a pull request.
Syntax
collator.resolvedOptions()
Return value
A new object with properties reflecting the locale and collation options computed during the initialization of the given Collator
object.
Description
The resulting 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
. -
usage
-
sensitivity
-
ignorePunctuation
-
The values provided for these properties in the
options
argument or filled in as defaults. -
collation
-
The value requested using the Unicode extension key
"co"
, if it is supported forlocale
, or"default"
. -
numeric
-
caseFirst
-
The values requested for these properties in the
options
argument or using the Unicode extension keys"kn"
and"kf"
or filled in as defaults. If the implementation does not support these properties, they are omitted.
Examples
Using the resolvedOptions
method
var de = new Intl.Collator('de', { sensitivity: 'base' }) var usedOptions = de.resolvedOptions(); usedOptions.locale; // "de" usedOptions.usage; // "sort" usedOptions.sensitivity; // "base" usedOptions.ignorePunctuation; // false usedOptions.collation; // "default" usedOptions.numeric; // false
Specifications
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out
https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | Server | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
resolvedOptions |
Chrome Full support 24 | Edge Full support 12 | Firefox Full support 29 | IE Full support 11 | Opera Full support 15 | Safari Full support 10 | WebView Android No support No | Chrome Android Full support 26 | Firefox Android Full support 56 | Opera Android ? | Safari iOS Full support 10 | Samsung Internet Android Full support 1.5 | nodejs ? |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown