Intl.Locale.prototype.getCollations()

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

The getCollations() method of Intl.Locale instances returns a list of one or more collation types for this locale.

Note: In some versions of some browsers, this method was implemented as an accessor property called collations. However, because it returns a new array on each access, it is now implemented as a method to prevent the situation of locale.collations === locale.collations returning false. Check the browser compatibility table for details.

Syntax

js
getCollations()

Parameters

None.

Return value

An array of strings representing all collation types commonly used for the Locale, sorted in alphabetical order, with the standard and search values always excluded. If the Locale already has a collation, then the returned array contains that single value.

For a list of supported collation types, see Intl.supportedValuesOf().

Examples

Obtaining supported collation types

If the Locale object doesn't have a collation already, getCollations() lists all commonly-used collation types for the given Locale. For examples of explicitly setting a collation, see collation examples.

js
const locale = new Intl.Locale("zh");
console.log(locale.getCollations()); // ["pinyin", "stroke", "zhuyin", "emoji", "eor"]

Specifications

Specification
Intl Locale Info Proposal
# sec-Intl.Locale.prototype.getCollations

Browser compatibility

BCD tables only load in the browser

See also