W3cubDocs

/JavaScript

Object.prototype.toLocaleString()

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

Try it

Syntax

toLocaleString()

Return value

A string representing the object.

Description

Object's toLocaleString returns the result of calling toString().

This function is provided to give objects a generic toLocaleString method, even though not all may use it. See the list below.

Objects overriding toLocaleString

Examples

Array toLocaleString() override

On Array objects, toLocaleString() can be used to print array values as a string, optionally with locale-specific identifiers (such as currency symbols) appended to them:

For example:

const testArray = [4, 7, 10];

const euroPrices = testArray.toLocaleString('fr', {
  style: 'currency',
  currency: 'EUR',
});
// "4,00 €,7,00 €,10,00 €"

Date toLocaleString() override

On Date objects, toLocaleString() is used to print out date displays more suitable for specific locales:

For example:

const testDate = new Date(Date.now());
// "Date Fri May 29 2020 18:04:24 GMT+0100 (British Summer Time)"

const deDate = testDate.toLocaleString('de');
// "29.5.2020, 18:04:24"

const frDate = testDate.toLocaleString('fr');
// "29/05/2020, 18:04:24"

Number toLocaleString() override

On Number objects, toLocaleString() is used to print out number displays more suitable for specific locales, e.g. with the correct separators:

For example:

const testNumber = 2901234564;
// "2901234564"

const deNumber = testNumber.toLocaleString('de');
// "2.901.234.564"

const frNumber = testNumber.toLocaleString('fr');
// "2 901 234 564"

Specifications

Browser compatibility

Desktop Mobile Server
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet Deno Node.js
toLocaleString
1
12
1
5.5
4
1
4.4
18
4
10.1
1
1.0
1.0
0.10.0

See also

© 2005–2022 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/toLocaleString