Array.prototype.toLocaleString()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2017.

Die toLocaleString() Methode von Array Instanzen gibt einen String zurück, der die Elemente des Arrays repräsentiert. Die Elemente werden unter Verwendung ihrer toLocaleString-Methoden in Strings umgewandelt, und diese Strings werden durch einen lokalen spezifischen String (wie ein Komma ",") getrennt.

Probieren Sie es aus

Syntax

js
toLocaleString()
toLocaleString(locales)
toLocaleString(locales, options)

Parameter

locales Optional

Ein String mit einem BCP 47 Sprach-Tag oder ein Array solcher Strings. Für die allgemeine Form und Interpretation des locales-Arguments siehe die Parameterbeschreibung auf der Intl Hauptseite.

options Optional

Ein Objekt mit Konfigurationseigenschaften. Für Nummern siehe Number.prototype.toLocaleString(); für Daten siehe Date.prototype.toLocaleString().

Rückgabewert

Ein String, der die Elemente des Arrays repräsentiert.

Beschreibung

Die Array.prototype.toLocaleString-Methode durchläuft ihren Inhalt, ruft für jedes Element die toLocaleString-Methode mit den bereitgestellten locales und options Parametern auf und verknüpft diese mit einem implementationsdefinierten Trennzeichen (wie einem Komma ","). Beachten Sie, dass die Methode selbst die beiden Parameter nicht direkt nutzt — sie übergibt sie nur an die toLocaleString() jeder Elemente. Die Wahl des Trennzeichen-Strings hängt von der aktuellen lokale Umgebung des Hosts ab, nicht vom locales-Parameter.

Wenn ein Element undefined, null ist, wird es in einen leeren String anstelle des Strings "null" oder "undefined" umgewandelt.

Wenn toLocaleString() auf dünn besetzten Arrays verwendet wird, iteriert die Methode leere Slots, als hätten sie den Wert undefined.

Die toLocaleString() Methode ist generisch. Sie erwartet nur, dass der this Wert eine length Eigenschaft und integer-keyed properties hat.

Beispiele

Verwendung von locales und options

Die Elemente des Arrays werden in Strings umgewandelt, indem ihre toLocaleString-Methoden verwendet werden.

Stets die Währung für die Strings und Zahlen im prices-Array anzeigen:

js
const prices = ["¥7", 500, 8123, 12];
prices.toLocaleString("ja-JP", { style: "currency", currency: "JPY" });

// "¥7,¥500,¥8,123,¥12"

Für weitere Beispiele siehe auch die Seiten zu Intl.NumberFormat und Intl.DateTimeFormat.

Verwendung von toLocaleString() auf dünn besetzten Arrays

toLocaleString() behandelt leere Slots wie undefined und erzeugt einen zusätzlichen Trennzeichen:

js
console.log([1, , 3].toLocaleString()); // '1,,3'

Aufruf von toLocaleString() auf Nicht-Array-Objekten

Die toLocaleString() Methode liest die length-Eigenschaft von this und greift dann auf jede Eigenschaft zu, deren Schlüssel eine nicht negative ganze Zahl kleiner als length ist.

js
const arrayLike = {
  length: 3,
  0: 1,
  1: 2,
  2: 3,
  3: 4, // ignored by toLocaleString() since length is 3
};
console.log(Array.prototype.toLocaleString.call(arrayLike));
// 1,2,3

Spezifikationen

Specification
ECMAScript Language Specification
# sec-array.prototype.tolocalestring
ECMAScript Internationalization API Specification
# sup-array.prototype.tolocalestring

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch