Web/JavaScript/Reference/Global objects/Object/toLocaleString
The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.
The source for this interactive example is stored in a GitHub repository. If you'd like to contribute to the interactive examples project, please clone https://github.com/mdn/interactive-examples and send us a pull request.
Syntax
obj.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
Array:Array.prototype.toLocaleString()Number:Number.prototype.toLocaleString()Date:Date.prototype.toLocaleString()TypedArray:TypedArray.prototype.toLocaleString()BigInt:BigInt.prototype.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];
let 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)"
let deDate = testDate.toLocaleString('de');
// "29.5.2020, 18:04:24"
var 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"
let deNumber = testNumber.toLocaleString('de');
// "2.901.234.564"
let frNumber = testNumber.toLocaleString('fr');
// "2 901 234 564"
Specifications
| Specification |
|---|
| ECMAScript (ECMA-262)The definition of 'Object.prototype.toLocaleString' in that specification. |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
| Desktop | Mobile | Server | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
toLocaleString
|
Chrome
Full support 1 |
Edge
Full support 12 |
Firefox
Full support 1 |
IE
Full support 5.5 |
Opera
Full support 4 |
Safari
Full support 1 |
WebView Android
Full support 1 |
Chrome Android
Full support 18 |
Firefox Android
Full support 4 |
Opera Android
Full support 10.1 |
Safari iOS
Full support 1 |
Samsung Internet Android
Full support 1.0 |
nodejs
Full support Yes |
Legend
- Full support
- Full support
See also
Object.prototype.toLocaleString() by Mozilla Contributors is licensed under CC-BY-SA 2.5.