• JavaScript Video Tutorials

JavaScript Date toLocaleDateString() Method



In JavaScript, the Date.toLocaleDateString() method is used to convert a date object to a string, representing the date portion of the date according to the current locale format.

The toLocaleDateString() method returns a string representing the date portion of the given Date object according to the locale-specific conventions and formatting options. The format of the returned string may vary depending on the locale and the options provided.

Syntax

Following is the syntax of JavaScript Date toLocaleDateString() method −

toLocaleDateString(locales, options);

Parameters

This method accepts two parameters. The same are described below −

  • locales (optional) − A string or an array of strings that represents a BCP 47 language tag, or an array of such strings. It specifies one or more locales for the date formatting. If the locales parameter is undefined or an empty array, the default locale of the runtime is used.
  • options (optional) − An object that contains properties for customizing the date format. This object can have properties like 'weekday', 'year', 'month', 'day', etc. Each property can have values like 'numeric', '2-digit', 'long', 'short', or 'narrow' to customize the display of that part of the date.

Return Value

This method returns only date (not time) of a date object as a string, using the locale conventions.

Example 1

In the following example, we are demonstrating the basic usage of JavaScript Date toLocaleDateString() method −

<html>
<body>
<script>
   const today = new Date();
   const dateString = today.toLocaleDateString();

   document.write(dateString);
</script>
</body>
</html>

Output

The above program returns the date of a date object as a string, using locale conventions.

Example 2

In this example, we are using the "options" parameter to specify a long-form date format, including the weekday, month, day, and year. We are also setting the locale to "en-US" −

<html>
<body>
<script>
   const today = new Date();
   const options = { weekday: 'long', year: 'numeric', month: 'long', day: 'numeric' };
   const dateString = today.toLocaleDateString('en-US', options);

   document.write(dateString);
</script>
</body>
</html>

Output

As we can see in the output, it displays a long-form date format.

Example 3

Here, we are using different locales by passing the specified locale string as the first argument to toLocaleDateString() method −

<html>
<body>
<script>
   const today = new Date();
   const options = { weekday: 'long', year: 'numeric', month: 'long', day: 'numeric' };

   document.write(today.toLocaleDateString('en-US', options), "
"); document.write(today.toLocaleDateString('fr-FR', options)); </script> </body> </html>

Output

The above program returns the date string in "US English" and "Standard French".

Advertisements