Intl.Locale.prototype.hourCycle

The Intl.Locale.prototype.hourCycle property is an accessor property that returns the time keeping format convention used by the locale.

Description

There are 2 main types of time keeping conventions (clocks) used around the world: the 12 hour clock and the 24 hour clock. The hourCycle property makes it easier for JavaScript programmers to access the clock type used by a particular locale. Like other additional locale data, hour cycle type is an extension subtag, which extends the data contained in a locale string. The hour cycle type can have several different values, which are listed in the table below.

Valid hour cycle types

Examples

These examples will show you how to add hour cycle data to your Locale object.

Adding an hour cycle via the locale string

In the Unicode locale string spec, the hour cycle is a locale string "extension subtag". These subtags add additional data about the locale, and are added to locale identifiers by using the -u extension key. Thus, the hour cycle type can be added to the inital locale identifier string that is passed into the Locale constructor. To add the hour cycle type, first add the -u extension key to the string. Next, add the -hc extension key to indicate that you are adding an hour cycle. Finally, add the hour cycle type to the string.

let fr24hour = new Intl.Locale("fr-FR-u-hc-h23");
console.log(fr24hour.hourCycle); // Prints "h23"

Adding an hour cycle via the configuration object argument

The Intl.Locale constructor has an optional configuration object argument, which can contain any of several extension types, including hour cycle types. Set the hour cycle property of the configuration object to your desired hour cycle type, and then pass it into the constructor.

let us12hour = new Intl.Locale("en-US-u-hc-h12");
console.log(us12hour.hourCycle); // Prints "h12"

Specifications

Browser compatibility

See also

• Intl.Locale
• Unicode Hour Cycle extension key spec