Temporal.PlainMonthDay.prototype.toLocaleString()

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Die toLocaleString()-Methode von Temporal.PlainMonthDay Instanzen gibt einen String mit einer sprachsensitiven Darstellung dieses Monats-Tages zurück. In Implementierungen mit Unterstützung der Intl.DateTimeFormat API delegiert diese Methode an Intl.DateTimeFormat.

Jedes Mal, wenn toLocaleString aufgerufen wird, muss eine Suche in einer großen Datenbank von Lokalisierungs-Strings durchgeführt werden, was potenziell ineffizient ist. Wenn die Methode häufig mit denselben Argumenten aufgerufen wird, ist es besser, ein Intl.DateTimeFormat-Objekt zu erstellen und dessen format()-Methode zu verwenden, da ein DateTimeFormat-Objekt sich die übergebenen Argumente merkt und sich möglicherweise dafür entscheidet, einen Teil der Datenbank zu zwischenspeichern, sodass zukünftige format-Aufrufe die Lokalisierungs-Strings in einem enger begrenzten Kontext durchsuchen können.

Syntax

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

Parameter

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

In Implementierungen, die die Intl.DateTimeFormat API unterstützen, entsprechen diese Parameter genau den Parametern des Intl.DateTimeFormat()-Konstruktors. Implementierungen ohne Unterstützung für Intl.DateTimeFormat geben genau denselben String zurück wie toString() und ignorieren beide Parameter.

locales Optional

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

options Optional

Ein Objekt zur Anpassung des Ausgabeformats. Entspricht dem options-Parameter des Intl.DateTimeFormat()-Konstruktors. Die calendar-Option muss mit demselben Wert angegeben werden wie der Kalender dieses Monats-Tages. Bezüglich der Optionen für Datum-Zeit-Komponenten und der Stilabkürzungen (dateStyle und timeStyle) sollte eine der folgenden Formen verwendet werden:

Keine der Optionen angeben: month und day werden standardmäßig auf "numeric" gesetzt.
Nur dateStyle angeben: Es wird auf month- und day-Formate erweitert.
Einige Optionen für Datum-Zeit-Komponenten angeben, wobei mindestens eine davon month oder day ist. Nur die angegebenen Datenkomponenten werden in die Ausgabe einbezogen.

Weitere Informationen zu diesen Parametern und deren Verwendung finden Sie im Intl.DateTimeFormat()-Konstruktor.

Rückgabewert

Ein String, der den angegebenen Monat-Tag gemäß sprachspezifischen Konventionen darstellt.

In Implementierungen mit Intl.DateTimeFormat ist dies gleichbedeutend mit new Intl.DateTimeFormat(locales, options).format(monthDay), wobei options wie oben beschrieben normalisiert wurde.

Hinweis: Die Formatierung, die von toLocaleString() zurückgegeben wird, ist meist konsistent. Allerdings kann die Ausgabe zwischen Implementierungen variieren, selbst innerhalb derselben Locale — diese Ausgabevariationen sind von Design her vorgesehen und durch die Spezifikation erlaubt. Möglicherweise entspricht sie auch nicht Ihren Erwartungen. Beispielsweise kann der String geschützte Leerzeichen verwenden oder von bidirektionalen Steuerzeichen umgeben sein. Sie sollten die Ergebnisse von toLocaleString() nicht mit fest codierten Konstanten vergleichen.

Ausnahmen

RangeError: Wird ausgelöst, wenn eine der Optionen ungültig ist.
TypeError: Wird ausgelöst, wenn eine der Optionen nicht den erwarteten Typ hat.

Beispiele

Verwendung von toLocaleString()

Der grundlegende Gebrauch dieser Methode ohne Angabe einer locale gibt einen formatierten String in der Standardsprache mit Standardoptionen zurück.

// Note that just specifying "08-01" defaults to the ISO 8601 calendar,
// which throws an error if the locale's default calendar is not ISO 8601.
const md = Temporal.PlainMonthDay.from("2021-08-01[u-ca=gregory]");

console.log(md.toLocaleString()); // 8/1 (assuming en-US locale and Gregorian calendar)

Wenn der Kalender des Monats-Tages nicht mit dem Standardkalender der Locale übereinstimmt, muss selbst wenn sein Kalender iso8601 ist, eine explizite calendar-Option mit demselben Wert angegeben werden.

const md = Temporal.PlainMonthDay.from("08-01");
md.toLocaleString("en-US", { calendar: "iso8601" }); // 08-01

Verwendung von toLocaleString() mit Optionen

Sie können anpassen, welche Teile des Monats-Tages in die Ausgabe aufgenommen werden, indem Sie den options-Parameter angeben.

const md = Temporal.PlainMonthDay.from("2021-08-01[u-ca=gregory]");
md.toLocaleString("en-US", { dateStyle: "full" }); // August 1
md.toLocaleString("en-US", { month: "long" }); // August
md.toLocaleString("en-US", { day: "numeric" }); // 1

Spezifikationen

Specification
Temporal # sec-temporal.plainmonthday.prototype.tolocalestring

Browser-Kompatibilität

Siehe auch

Help improve MDN

Learn how to contribute Diese Seite wurde automatisch aus dem Englischen übersetzt.

Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden