Intl.Collator()

Creates a newCollator object.

Intl.Collator.supportedLocalesOf()

Returns an array containing those of the provided locales that are supported without having to fall back to the runtime's default locale.

These properties are defined onIntl.Collator.prototype and shared by allIntl.Collator instances.

Intl.Collator.prototype.constructor

The constructor function that created the instance object. ForIntl.Collator instances, the initial value is theIntl.Collator constructor.

Intl.Collator.prototype[Symbol.toStringTag]

The initial value of the[Symbol.toStringTag] property is the string"Intl.Collator". This property is used inObject.prototype.toString().

Intl.Collator.prototype.compare()

Getter function that compares two strings according to the sort order of thisIntl.Collator object.

Intl.Collator.prototype.resolvedOptions()

Returns a new object with properties reflecting the locale and collation options computed during initialization of the object.

The following example demonstrates the different potential results for a string occurring before, after, or at the same level as another:

console.log(new Intl.Collator().compare("a", "c")); // -1, or some other negative valueconsole.log(new Intl.Collator().compare("c", "a")); // 1, or some other positive valueconsole.log(new Intl.Collator().compare("a", "a")); // 0

Note that the results shown in the code above can vary between browsers and browser versions. This is because the values are implementation-specific. That is, the specification requires only that the before and after values are negative and positive.

The results provided byIntl.Collator.prototype.compare() vary between languages. In order to get the sort order of the language used in the user interface of your application, make sure to specify that language (and possibly some fallback languages) using thelocales argument:

// in German, ä sorts with aconsole.log(new Intl.Collator("de").compare("ä", "z"));// -1, or some other negative value// in Swedish, ä sorts after zconsole.log(new Intl.Collator("sv").compare("ä", "z"));// 1, or some other positive value

The results provided byIntl.Collator.prototype.compare() can be customized using theoptions argument:

// in German, ä has a as the base letterconsole.log(new Intl.Collator("de", { sensitivity: "base" }).compare("ä", "a"));// 0// in Swedish, ä and a are separate base lettersconsole.log(new Intl.Collator("sv", { sensitivity: "base" }).compare("ä", "a"));// 1, or some other positive value

• Intl
• String.prototype.localeCompare()