Array.prototype.toLocaleString()
The toLocaleString() method returns a string representing
the elements of the array. The elements are converted to Strings using their
toLocaleString methods and these Strings are separated by a locale-specific
String (such as a comma ",").
Syntax
toLocaleString()
toLocaleString(locales)
toLocaleString(locales, options)
Parameters
localesoptional- : A string with a BCP 47 language tag, or an array of such strings. For the general form and interpretation of the
localesargument, see Locale identification and negotiation.
- : A string with a BCP 47 language tag, or an array of such strings. For the general form and interpretation of the
optionsoptional- : An object with configuration properties. For numbers, see
Number.prototype.toLocaleString(); for dates, seeDate.prototype.toLocaleString().
- : An object with configuration properties. For numbers, see
Return value
A string representing the elements of the array.
Description
The Array.prototype.toLocaleString method traverses its content, calling the toLocaleString method of every element with the locales and options parameters provided, and concatenates them with an implementation-defined separator (such as a comma ","). Note that the method itself does not consume the two parameters — it only passes them to the toLocaleString() of each element. The choice of the separator string depends on the host's current locale, not the locales parameter.
If an element is undefined, null, it is converted to an empty string instead of the string "null" or "undefined".
When used on sparse arrays, the toLocaleString() method iterates empty slots as if they have the value undefined.
The toLocaleString() method is generic. It only expects the this value to have a length property and integer-keyed properties.