Intl.Collator.prototype.resolvedOptions()

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.

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 for locale, 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

Specification
ECMAScript Internationalization API (ECMA-402)
The definition of 'Intl.Collator.prototype.resolvedOptions' in that specification.

Browser compatibility

Update compatibility data on GitHub
DesktopMobileServer
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung InternetNode.js
resolvedOptionsChrome Full support 24Edge Full support 12Firefox Full support 29IE Full support 11Opera Full support 15Safari Full support 10WebView Android Full support 4.4Chrome Android Full support 25Firefox Android Full support 56Opera Android Full support 14Safari iOS Full support 10Samsung Internet Android Full support 1.5nodejs Full support 0.12
Notes
Full support 0.12
Notes
Notes Before version 13.0.0, only the locale data for en-US is available by default. See the Collator() constructor for more details.

Legend

Full support  
Full support
See implementation notes.
See implementation notes.

See also