BigInt.prototype.toLocaleString()

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 Unterstützung für Intl.NumberFormat werden gebeten, beide Parameter zu ignorieren, so dass die verwendete Sprache und die Form der zurückgegebenen Zeichenkette vollständig von der Implementierung abhängt.

locales Optional

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

In Implementierungen ohne Unterstützung für Intl.NumberFormat wird dieser Parameter ignoriert und in der Regel die Sprache des Hosts verwendet.

options Optional

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

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

Siehe den Intl.NumberFormat()-Konstruktor für Details zu diesen Parametern und deren Verwendung.

Eine Zeichenkette, die das gegebene BigInt gemäß sprachspezifischer Konventionen darstellt.

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

Die grundlegende Nutzung dieser Methode ohne Angabe eines locales liefert eine formatierte Zeichenkette in der Standardsprache und mit Standardoptionen.

const bigint = 3500n;

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

Die Parameter locales und options werden möglicherweise nicht in allen Implementierungen unterstützt, da die Unterstützung der Internationalisierungs-API optional ist und einige Systeme eventuell nicht die erforderlichen Daten haben. Für Implementierungen ohne Unterstützung für Internationalisierung verwendet toLocaleString() stets die Systemsprache, die möglicherweise nicht den Erwartungen entspricht. Da jede Implementierung, die die Parameter locales und options unterstützt, die Intl API unterstützen muss, können Sie deren Vorhandensein zur Unterstützung prüfen:

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

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 diese Sprache (und möglicherweise einige Ausweichsprachen) mit dem locales-Argument angeben:

const bigint = 123456789123456789n;

// German uses period for thousands
console.log(bigint.toLocaleString("de-DE"));
// 123.456.789.123.456.789

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

// India uses thousands/lakh/crore separators
console.log(bigint.toLocaleString("en-IN"));
// 1,23,45,67,89,12,34,56,789

// the nu extension key requests a numbering system, e.g. Chinese decimal
console.log(bigint.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(bigint.toLocaleString(["ban", "id"]));
// 123.456.789.123.456.789

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

const bigint = 123456789123456789n;

// request a currency format
console.log(
  bigint.toLocaleString("de-DE", { style: "currency", currency: "EUR" }),
);
// 123.456.789.123.456.789,00 €

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

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

• Intl.NumberFormat
• BigInt.prototype.toString()