Intl.supportedValuesOf()

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The Intl.supportedValuesOf() method returns an array containing the supported calendar, collation, currency, numbering systems, or unit values supported by the implementation.

Duplicates are omitted and the array is sorted in ascending alphabetic order (or more precisely, using Array.prototype.sort() with an undefined compare function)

The method can be used to feature-test whether values are supported in a particular implementation and download a polyfill only if neccesary. It can also be used to build UIs that allow users to select their preferred localised values, for example when the UI is created from WebGL or server-side.

Syntax

Intl.supportedValuesOf(key)

Parameters

key

A key string indicating the category of values to be returned. This is one of: "calendar", "collation", "currency","numberingSystem", "timeZone", "unit".

Return value

A sorted array of unique string values indicating the values supported by the implementation for the given key.

Exceptions

RangeError

An unsupported key was passed as a parameter.

Examples

Feature testing

You can check that the method is supported by comparing to undefined:

if (typeof Intl.supportedValuesOf !== 'undefined') { 
  //method is supported
}

Get all values for key

To get the supported values for calendar you call the method with the key "calendar". YOu can then iterate through the returned array as shown below:

Intl.supportedValuesOf("calendar").forEach(function(calendar) {
   // "buddhist", "chinese", "coptic", "dangi", ...
});

Note: The array returned for calendar values will always include the value "gregory" (gregorian).

The other values are all obtained in the same way:

Intl.supportedValuesOf("collation").forEach(function(collation) {
   // "big5han", "compat", "dict", "emoji", ...
});

Intl.supportedValuesOf("currency").forEach(function(currency) {
   // "ADP", "AED", "AFA", "AFN", "ALK", "ALL", "AMD", ...
});

Intl.supportedValuesOf("numberingSystem").forEach(function(numberingSystem) {
   // "adlm", "ahom", "arab", "arabext", "bali", ...
});

Intl.supportedValuesOf("timeZone").forEach(function(timeZone) {
   // "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", ...
});

Intl.supportedValuesOf("unit").forEach(function(unit) {
   // "acre", "bit", "byte", "celsius", "centimeter", ...
});

Invalid key throws RangeError

try {
  Intl.supportedValuesOf("someInvalidKey");
} catch (err) {
  //Error: RangeError: invalid key: "someInvalidKey"
}

Polyfill

Intl.supportedValuesOf() polyfill in proposal TC39

Specifications

Specification
Intl Enumeration API Specification (Intl Enumeration API)
# sec-intl.supportedvaluesof

Browser compatibility

BCD tables only load in the browser

See also