The toLocaleString()
method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.
obj.toLocaleString()
A string representing the object.
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.
Array
: Array.prototype.toLocaleString()
Number
: Number.prototype.toLocaleString()
Date
: Date.prototype.toLocaleString()
TypedArray
: TypedArray.prototype.toLocaleString()
BigInt
: BigInt.prototype.toLocaleString()
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]; let euroPrices = testArray.toLocaleString('fr', { style: 'currency', currency: 'EUR'}); // "4,00 €,7,00 €,10,00 €"
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)" let deDate = testDate.toLocaleString('de'); // "29.5.2020, 18:04:24" var frDate = testDate.toLocaleString('fr'); //"29/05/2020 à 18:04:24"
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" let deNumber = testNumber.toLocaleString('de'); // "2.901.234.564" let frNumber = testNumber.toLocaleString('fr'); // "2 901 234 564"
Specification |
---|
ECMAScript (ECMA-262) The definition of 'Object.prototype.toLocaleString' in that specification. |
Desktop | ||||||
---|---|---|---|---|---|---|
toLocaleString |
1 | 12 | 1 | 5.5 | 4 | 1 |
Mobile | ||||||
---|---|---|---|---|---|---|
toLocaleString |
1 | 18 | 4 | 10.1 | 1 | 1.0 |
Server | |
---|---|
toLocaleString |
Yes |
© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://wiki.developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/toLocaleString