Intl.getCanonicalLocales()
The Intl.getCanonicalLocales() method returns an array
containing the canonical locale names. Duplicates will be omitted and elements will be
validated as structurally valid language tags.
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
Intl.getCanonicalLocales(locales)Parameters
locales- A list of
Stringvalues for which to get the canonical locale names.
Return value
An array containing the canonical locale names.
Examples
Using getCanonicalLocales
Intl.getCanonicalLocales('EN-US'); // ["en-US"]
Intl.getCanonicalLocales(['EN-US', 'Fr']); // ["en-US", "fr"]
Intl.getCanonicalLocales('EN_US');
// RangeError:'EN_US' is not a structurally valid language tag
Polyfill
Specifications
| Specification |
|---|
| ECMAScript Internationalization API (ECMA-402) The definition of 'Intl.getCanonicalLocales' in that specification. |
Browser compatibility
BCD tables only load in the browser