Using toLocaleString with Numbers, Arrays or Dates in JavaScript


While this tutorial has content that we believe is of great benefit to our community, we have not yet tested or edited it to ensure you have an error-free learning experience. It's on our list, and we're working on it! You can help us out by using the "report an issue" button at the bottom of the tutorial.

toLocaleString is a built-in JavaScript method used to convert the date and time to a string using the system locales. πŸ€“πŸš€

It can be used with the following JavaScript types πŸ’ͺ:

  • Dates/Time
  • Numbers
  • Objects
  • Arrays

toLocaleString with Dates and Time πŸš€

With dates/time objects, toLocaleString has a syntax like this and returns a string πŸ”₯πŸ‘‰:

dateObject.toLocaleString(locales, options)
  • locales: An optional string that specifies a language-specific format. Some valid values are ar-SA (for Arabic), en-US (for US English), hi-IN (for Hindi), jp-JP (for Japanese), etc.
  • options: An optional object of options. Some valid properties that can be included in this are dateStyle with values of full, long, medium and short. Other possible properties are timeStyle, weekday, year, month, day, hour, minute, second, etc.

Example 😍

const date = new Date();

// 11/10/2019, 4:32:44 PM

// 10/11/2019, 4:32:44 pm

// 10.11.2019 Γ  16:32:44

const options = {
  weekday: 'long',
  era: 'long'

console.log(date.toLocaleString(`en-US`, options)); 
// Sunday Anno Domini

console.log(date.toLocaleString(`hi-IN`, options));
// ΰ€ˆΰ€Έΰ€΅ΰ₯€ ΰ€Έΰ€¨ ΰ€°ΰ€΅ΰ€Ώΰ€΅ΰ€Ύΰ€°

console.log(date.toLocaleString(`fr-CH`, options));
// après Jésus-Christ dimanche

toLocaleString with Numbers πŸš€

With numbers, toLocaleString is used to convert the numbers into a locale-specific number representation. It has syntax something like the following and returns a string πŸ”₯πŸ‘‰:

number.toLocaleString(locales, options)
  • locales: An optional string the specifies the locale.
  • options: An optional object that can contain properties such as localeMatcher with values lookup and best fit. Other valied properties are style, currency, useGrouping, minimumSignificantDigits, etc.

Example 😍

const number = 12345.678;

// 12,345.678

// 12 345,678

console.log(number.toLocaleString('en-US', {
  style: 'currency',
  currency: 'USD'   // With currency, the currency code is also required
}));  // $12,345.68

console.log(number.toLocaleString('hi-IN', {
  style: 'currency',
  currency: 'INR'
}));  // β‚Ή12,345.68

console.log(number.toLocaleString('en-US', {
  style: 'currency',
  currency: 'USD',
  maximumSignificantDigits: 2
}));  // $12,000

toLocaleString with Arrays πŸš€

With arrays, toLocaleString is used to convert them into a locale-specific representation. The syntax is as follows and once again a string is returned πŸ”₯πŸ‘‰:

array.toLocaleString(locales, options)
  • locales: An optional string specifying the locale.
  • options: An optional object of the same options available to numbers and dates.

Example 😍

const arr = [12345678, new Date(), "alligators"];
  style: 'currency',
  currency: 'EUR',
  era: 'long'

//  12β€―345β€―678,00 €,10 11 2019 aprΓ¨s JΓ©sus-Christ Γ  18:30:03,alligators

const arr2 = [12345678, new Date(), "alligators"];
  style: 'currency',
  currency: 'USD',
  era: 'long'

//  $12,345,678.00,11 10, 2019 Anno Domini, 6:31:56 PM,alligators

Note: If locale is omitted or left undefined than the default system locale is used. πŸ§ͺ

πŸ₯“ Now what’s left is to make sure your targeted browsers support the toLocaleString method.

Creative Commons License