Date.toLocaleTimeString()
Returns the time portion of a Date object as a string, using locale conventions
Last updated
Returns the time portion of a Date object as a string, using locale conventions
Last updated
The toLocaleTimeString() method returns a string with a language sensitive representation of the time portion of this date.
The new locales
and options
arguments let applications specify the language whose formatting conventions should be used and customise the behaviour of the function. In older implementations, which ignore the locales
and options
arguments, the locale used and the form of the string returned are entirely implementation dependent.
locales
Optional. A string with a BCP 47 language tag, or an array of such strings. For the general form and interpretation of the locales
argument, see the . The following Unicode extension keys are allowed:
nu
Numbering system. Possible values include: "arab"
, "arabext"
, "bali"
, "beng"
, "deva"
, "fullwide"
, "gujr"
, "guru"
, "hanidec"
, "khmr"
, "knda"
, "laoo"
, "latn"
, "limb"
, "mlym"
, "mong"
, "mymr"
, "orya"
, "tamldec"
, "telu"
, "thai"
, "tibt"
.
ca
Calendar. Possible values include: "buddhist"
, "chinese"
, "coptic"
, "ethioaa"
, "ethiopic"
, "gregory"
, "hebrew"
, "indian"
, "islamic"
, "islamicc"
, "iso8601"
, "japanese"
, "persian"
, "roc"
.
hc
Hour cycle. Possible values include: "h11"
, "h12"
, "h23"
, "h24"
.
options
Optional. An object with some or all of the following properties:
hour12
Whether to use 12-hour time (as opposed to 24-hour time). Possible values are true
and false
; the default is locale dependent. This option overrides the hc
language tag and/or the hourCycle
option in case both are present.
hourCycle
The hour cycle to use. Possible values are "h11"
, "h12"
, "h23"
, or "h24"
. This option overrides the hc
language tag, if both are present, and the hour12
option takes precedence in case both options have been specified.
formatMatcher
The format matching algorithm to use. Possible values are "basic"
and "best fit"
; the default is "best fit"
. See the following paragraphs for information about the use of this property.
The following properties describe the date-time components to use in formatted output, and their desired representations. Implementations are required to support at least the following subsets:
weekday
, year
, month
, day
, hour
, minute
, second
weekday
, year
, month
, day
year
, month
, day
year
, month
month
, day
hour
, minute
, second
hour
, minute
weekday
The representation of the weekday. Possible values are "narrow"
, "short"
, "long"
.
era
The representation of the era. Possible values are "narrow"
, "short"
, "long"
.
year
The representation of the year. Possible values are "numeric"
, "2-digit"
.
month
The representation of the month. Possible values are "numeric"
, "2-digit"
, "narrow"
, "short"
, "long"
.
day
The representation of the day. Possible values are "numeric"
, "2-digit"
.
hour
The representation of the hour. Possible values are "numeric"
, "2-digit"
.
minute
The representation of the minute. Possible values are "numeric"
, "2-digit"
.
second
The representation of the second. Possible values are "numeric"
, "2-digit"
.
timeZoneName
The representation of the time zone name. Possible values are "short"
, "long"
.
Return value
toLocaleTimeString()
In basic use without specifying a locale, a formatted string in the default locale and with default options is returned.
locales
and options
argumentslocales
This example shows some of the variations in localized time formats. In order to get the format of the language used in the user interface of your application, make sure to specify that language (and possibly some fallback languages) using the locales
argument:
options
The results provided by toLocaleTimeString()
can be customized using the options
argument:
Uros Durdevic
localeMatcher
The locale matching algorithm to use. Possible values are "lookup"
and "best fit"
; the default is "best fit"
. For information about this option, see the .
timeZone
The time zone to use. The only value implementations must recognize is "UTC"
; the default is the runtime's default time zone. Implementations may also recognize the time zone names of the , such as "Asia/Shanghai"
, "Asia/Kolkata"
, "America/New_York"
.
Implementations may support other subsets, and requests will be negotiated against all available subset-representation combinations to find the best match. Two algorithms are available for this negotiation and selected by the formatMatcher
property: A and an implementation-dependent "best fit"
algorithm.
The default value for each date-time component property is , but if the weekday
, year
, month
, day
properties are all , then year
, month
, and day
are assumed to be "numeric"
.
A string representing the time portion of the given instance according to language-specific conventions.
The locales
and options
arguments are not supported in all browsers yet. To check whether an implementation supports them already, you can use the requirement that illegal language tags are rejected with a exception:
When formatting large numbers of dates, it is better to create an object and use the function provided by its property.