Date.prototype.toLocaleDateString()
The toLocaleDateString()
method of Date
instances returns a string with a language-sensitive representation of the date portion of this date in the local timezone. In implementations with Intl.DateTimeFormat
API support, this method simply calls Intl.DateTimeFormat
.
Every time toLocaleString
is called, it has to perform a search in a big database of localization strings, which is potentially inefficient. When the method is called many times with the same arguments, it is better to create a Intl.DateTimeFormat
object and use its format()
method, because a DateTimeFormat
object remembers the arguments passed to it and may decide to cache a slice of the database, so future format
calls can search for localization strings within a more constrained context.
Syntax
toLocaleDateString()
toLocaleDateString(locales)
toLocaleDateString(locales, options)
Parameters
The locales
and options
parameters customize the behavior of the function and let applications specify the language whose formatting conventions should be used.
In implementations that support the Intl.DateTimeFormat
API, these parameters correspond exactly to the Intl.DateTimeFormat()
constructor's parameters. Implementations without Intl.DateTimeFormat
support are asked to ignore both parameters, making the locale used and the form of the string returned entirely implementation-dependent.
locales
Optional
-
A string with a BCP 47 language tag, or an array of such strings. Corresponds to the locales
parameter of the Intl.DateTimeFormat()
constructor.
In implementations without Intl.DateTimeFormat
support, this parameter is ignored and the host's locale is usually used.
options
Optional
-
An object adjusting the output format. Corresponds to the options
parameter of the Intl.DateTimeFormat()
constructor. The timeStyle
option must be undefined, or a TypeError
would be thrown. If weekday
, year
, month
, and day
are all undefined, then year
, month
, and day
will be set to "numeric"
.
In implementations without Intl.DateTimeFormat
support, this parameter is ignored.
See the Intl.DateTimeFormat()
constructor for details on these parameters and how to use them.
Return value
A string representing the date portion of the given date according to language-specific conventions.
In implementations with Intl.DateTimeFormat
, this is equivalent to new Intl.DateTimeFormat(locales, options).format(date)
, where options
has been normalized as described above.
Note: Most of the time, the formatting returned by toLocaleDateString()
is consistent. However, the output may vary with time, language, and implementation — output variations are by design and allowed by the specification. You should not compare the results of toLocaleDateString()
to static values.
Using toLocaleDateString()
Basic use of this method without specifying a locale
returns a formatted string in the default locale and with default options.
const date = new Date(Date.UTC(2012, 11, 12, 3, 0, 0));
console.log(date.toLocaleDateString());
Checking for support for locales and options parameters
The locales
and options
parameters may not be supported in all implementations, because support for the internationalization API is optional, and some systems may not have the necessary data. For implementations without internationalization support, toLocaleDateString()
always uses the system's locale, which may not be what you want. Because any implementation that supports the locales
and options
parameters must support the Intl
API, you can check the existence of the latter for support:
function toLocaleDateStringSupportsLocales() {
return (
typeof Intl === "object" &&
!!Intl &&
typeof Intl.DateTimeFormat === "function"
);
}
Using locales
This example shows some of the variations in localized date 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:
const date = new Date(Date.UTC(2012, 11, 20, 3, 0, 0));
console.log(date.toLocaleDateString("en-US"));
console.log(date.toLocaleDateString("en-GB"));
console.log(date.toLocaleDateString("ko-KR"));
console.log(date.toLocaleDateString("fa-IR"));
console.log(date.toLocaleDateString("ar-EG"));
console.log(date.toLocaleDateString("ja-JP-u-ca-japanese"));
console.log(date.toLocaleDateString(["ban", "id"]));
Using options
The results provided by toLocaleDateString()
can be customized using the options
parameter:
const date = new Date(Date.UTC(2012, 11, 20, 3, 0, 0));
const options = {
weekday: "long",
year: "numeric",
month: "long",
day: "numeric",
};
console.log(date.toLocaleDateString("de-DE", options));
options.timeZone = "UTC";
options.timeZoneName = "short";
console.log(date.toLocaleDateString("en-US", options));
Specifications
Browser compatibility
|
Desktop |
Mobile |
Server |
|
Chrome |
Edge |
Firefox |
Opera |
Safari |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
WebView Android |
Deno |
Node.js |
toLocaleDateString |
1 |
12 |
1 |
5 |
1 |
18 |
4 |
10.1 |
1 |
1.0 |
4.4 |
1.0 |
0.10.0 |
iana_time_zone_names |
24 |
14 |
52 |
15 |
7 |
25 |
56 |
14 |
7 |
1.5 |
4.4 |
1.8 |
0.12.0 |
locales |
24 |
12 |
29 |
15 |
10 |
25 |
56 |
14 |
10 |
1.5 |
4.4 |
1.8
1.0–1.8Only the locale data for en-US is available.
|
13.0.0
0.12.0Before version 13.0.0, only the locale data for en-US is available by default. When other locales are specified, the function silently falls back to en-US . To make full ICU (locale) data available before version 13, see Node.js documentation on the --with-intl option and how to provide the data.
|
options |
24 |
12 |
29 |
15 |
10 |
25 |
56 |
14 |
10 |
1.5 |
4.4 |
1.0 |
0.12.0 |