The Intl.Locale() constructor creates Intl.Locale objects.
JavaScript Demo: Intl.Locale() constructor
const korean = new Intl.Locale("ko", {
script: "Kore",
region: "KR",
hourCycle: "h23",
calendar: "gregory",
});
const japanese = new Intl.Locale("ja-Jpan-JP-u-ca-japanese-hc-h12");
console.log(korean.baseName, japanese.baseName);
// Expected output: "ko-Kore-KR" "ja-Jpan-JP"
console.log(korean.hourCycle, japanese.hourCycle);
// Expected output: "h23" "h12"
Syntax
new Intl.Locale(tag)
new Intl.Locale(tag, options)
[!NOTE]
Intl.Locale()can only be constructed withnew. Attempting to call it withoutnewthrows a TypeError.
Parameters
tag- : The Unicode locale identifier string. For the syntax of locale identifier strings, see the Intl main page. Note that the
Intl.Localeconstructor, unlike most otherIntlconstructors, does not accept an array of locales orundefined.
- : The Unicode locale identifier string. For the syntax of locale identifier strings, see the Intl main page. Note that the
options- : An object that contains configuration for the Locale. Option values here take priority over extension keys in the locale identifier. Possible properties are:
language- : The language. Any syntactically valid string following the
unicode_language_subtaggrammar (2–3 or 5–8 letters) is accepted, but the implementation only recognizes certain kinds.
- : The language. Any syntactically valid string following the
script- : The script. Any syntactically valid string following the
unicode_script_subtaggrammar (4 letters) is accepted, but the implementation only recognizes certain kinds.
- : The script. Any syntactically valid string following the
region- : The region. Any syntactically valid string following the
unicode_region_subtaggrammar (either 2 letters or 3 digits) is accepted, but the implementation only recognizes certain kinds.
- : The region. Any syntactically valid string following the
variants- : The variants. It should be a dash (
-) separated list of unique variant tags, where each tag is any syntactically valid string following theunicode_variant_subtaggrammar (either 5–8 alphanumerals or a digit followed by 3 alphanumerals), but the implementation only recognizes certain kinds.
- : The variants. It should be a dash (
calendar- : The calendar. Any syntactically valid string following the
typegrammar (one or more segments of 3–8 alphanumerals, joined by hyphens) is accepted, but the implementation only recognizes certain kinds, which are listed inIntl.supportedValuesOf().
- : The calendar. Any syntactically valid string following the
collation- : The collation. Any syntactically valid string following the
typegrammar is accepted, but the implementation only recognizes certain kinds, which are listed inIntl.supportedValuesOf().
- : The collation. Any syntactically valid string following the
numberingSystem- : The numbering system. Any syntactically valid string following the
typegrammar is accepted, but the implementation only recognizes certain kinds, which are listed inIntl.supportedValuesOf().
- : The numbering system. Any syntactically valid string following the
caseFirst- : The case-first sort option. Possible values are
"upper","lower", or"false".
- : The case-first sort option. Possible values are
hourCycle- : The hour cycle. Possible values are
"h23","h12","h11", or the practically unused"h24", which are explained inIntl.Locale.prototype.getHourCycles
- : The hour cycle. Possible values are
numeric- : The numeric sort option. A boolean.
- : An object that contains configuration for the Locale. Option values here take priority over extension keys in the locale identifier. Possible properties are:
Examples
Basic usage
At its very simplest, the Intl.Locale() constructor takes
a locale identifier string as its argument:
const us = new Intl.Locale("en-US");
Using the Locale constructor with an options object
The constructor also takes an optional configuration object argument, which can contain
any of several extension types. For example, set the
hourCycle
property of the configuration object to your desired hour cycle type, and then pass it
into the constructor:
const locale = new Intl.Locale("en-US", { hourCycle: "h12" });
console.log(locale.hourCycle); // "h12"
Specifications
Browser compatibility
See also
- Intl.Collator
- Canonical Unicode Locale Identifiers in the Unicode locale data markup language spec
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
