Number.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 Number Werten gibt eine Zeichenkette mit einer sprachsensiblen Darstellung dieser Zahl zurück. In Implementierungen mit Unterstützung für die Intl.NumberFormat API delegiert diese Methode an Intl.NumberFormat.

Jedes Mal, wenn toLocaleString aufgerufen wird, muss in einer großen Datenbank von Lokalisierungszeichenketten gesucht werden, was potenziell ineffizient ist. Wenn die Methode oft mit denselben Argumenten aufgerufen wird, ist es besser, ein Intl.NumberFormat Objekt zu erstellen und dessen format() Methode zu verwenden, da ein NumberFormat Objekt sich die übergebenen Argumente merkt und möglicherweise einen Teil der Datenbank zwischenspeichert, damit zukünftige format Aufrufe innerhalb eines eingeschränkteren Kontexts nach Lokalisierungszeichenketten suchen können.

Probieren Sie es aus

Syntax

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

Parameter

Die Parameter locales und options passen das Verhalten der Funktion an und ermöglichen es Anwendungen, die Sprache anzugeben, deren Formatierungskonventionen verwendet werden sollen.

In Implementierungen, die die Intl.NumberFormat API unterstützen, entsprechen diese Parameter genau den Parametern des Konstruktors Intl.NumberFormat(). Implementierungen ohne Intl.NumberFormat Unterstützung werden gebeten, beide Parameter zu ignorieren, was die verwendete Lokalisierung und die Form der zurückgegebenen Zeichenkette vollständig implementierungsabhängig macht.

locales Optional

Ein String mit einem BCP 47 Sprach-Tag oder ein Array solcher Strings. Entspricht dem locales Parameter des Intl.NumberFormat() Konstruktors.

In Implementierungen ohne Intl.NumberFormat Unterstützung wird dieser Parameter ignoriert und normalerweise die Lokalisierung des Hosts verwendet.

options Optional

Ein Objekt, das das Ausgabeformat anpasst. Entspricht dem options Parameter des Intl.NumberFormat() Konstruktors.

In Implementierungen ohne Intl.NumberFormat Unterstützung wird dieser Parameter ignoriert.

Siehe den Intl.NumberFormat() Konstruktor für Details zu diesen Parametern und wie sie verwendet werden.

Rückgabewert

Eine Zeichenkette, die die gegebene Zahl gemäß sprachspezifischen Konventionen darstellt.

In Implementierungen mit Intl.NumberFormat entspricht dies new Intl.NumberFormat(locales, options).format(number).

Hinweis: Meistens ist die Formatierung, die von toLocaleString() zurückgegeben wird, konsistent. Allerdings kann die Ausgabe zwischen Implementierungen variieren, selbst innerhalb derselben Lokalisierung — Ausgabeschwankungen sind vom Design her vorgesehen und durch die Spezifikation erlaubt. Sie entspricht möglicherweise auch nicht Ihren Erwartungen. Beispielsweise könnte die Zeichenkette geschützte Leerzeichen verwenden oder von bidirektionalen Steuerzeichen umgeben sein. Sie sollten die Ergebnisse von toLocaleString() nicht mit festkodierten Konstanten vergleichen.

Beispiele

Verwendung von toLocaleString()

Die grundlegende Verwendung dieser Methode ohne Angabe einer locale gibt eine formatierte Zeichenkette in der Standard-Lokalisierung und mit Standardoptionen zurück.

js
const number = 3500;

console.log(number.toLocaleString()); // "3,500" if in U.S. English locale

Überprüfung der Unterstützung für locale- und options-Parameter

Die locales und options Parameter werden möglicherweise nicht in allen Implementierungen unterstützt, da die Unterstützung für die Internationalisierungs-API optional ist und einige Systeme möglicherweise nicht über die notwendigen Daten verfügen. Bei Implementierungen ohne Unterstützung für Internationalisierung verwendet toLocaleString() immer die Lokalisierung des Systems, die möglicherweise nicht Ihren Wünschen entspricht. Da jede Implementierung, die die locales und options Parameter unterstützt, die Intl API unterstützen muss, können Sie die Existenz dieser API zur Unterstützung überprüfen:

js
function toLocaleStringSupportsLocales() {
  return (
    typeof Intl === "object" &&
    !!Intl &&
    typeof Intl.NumberFormat === "function"
  );
}

Verwendung von locales

Dieses Beispiel zeigt einige der Variationen in lokalisierten Zahlenformaten. Um das Format der Sprache zu erhalten, die in der Benutzeroberfläche Ihrer Anwendung verwendet wird, sollten Sie sicherstellen, dass Sie diese Sprache (und möglicherweise einige Ersatzsprachen) mit dem locales Argument angeben:

js
const number = 123456.789;

// German uses comma as decimal separator and period for thousands
console.log(number.toLocaleString("de-DE"));
// 123.456,789

// Arabic in most Arabic speaking countries uses Eastern Arabic digits
console.log(number.toLocaleString("ar-EG"));
// ١٢٣٤٥٦٫٧٨٩

// India uses thousands/lakh/crore separators
console.log(number.toLocaleString("en-IN"));
// 1,23,456.789

// the nu extension key requests a numbering system, e.g. Chinese decimal
console.log(number.toLocaleString("zh-Hans-CN-u-nu-hanidec"));
// 一二三,四五六.七八九

// when requesting a language that may not be supported, such as
// Balinese, include a fallback language, in this case Indonesian
console.log(number.toLocaleString(["ban", "id"]));
// 123.456,789

Verwendung von options

Die von toLocaleString() bereitgestellten Ergebnisse können mit dem options Parameter angepasst werden:

js
const number = 123456.789;

// request a currency format
console.log(
  number.toLocaleString("de-DE", { style: "currency", currency: "EUR" }),
);
// 123.456,79 €

// the Japanese yen doesn't use a minor unit
console.log(
  number.toLocaleString("ja-JP", { style: "currency", currency: "JPY" }),
);
// ¥123,457

// limit to three significant digits
console.log(number.toLocaleString("en-IN", { maximumSignificantDigits: 3 }));
// 1,23,000

// Use the host default language with options for number formatting
const num = 30000.65;
console.log(
  num.toLocaleString(undefined, {
    minimumFractionDigits: 2,
    maximumFractionDigits: 2,
  }),
);
// "30,000.65" where English is the default language, or
// "30.000,65" where German is the default language, or
// "30 000,65" where French is the default language

Spezifikationen

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

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch