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 Lokalisierungsstrings 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 entscheiden kann, einen Teil der Datenbank im Cache zu halten, sodass zukünftige format Aufrufe Lokalisierungsstrings in einem eingeschränkteren Kontext suchen 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 exakt den Parametern des Intl.DateTimeFormat() Konstruktors. Implementierungen ohne Intl.DateTimeFormat Unterstützung geben exakt denselben String wie toString() zurück 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, das das Ausgabeformat anpasst. Entspricht dem options Parameter des Intl.DateTimeFormat() Konstruktors. Die calendar Option muss mit demselben Wert wie der Kalender dieses Monats-Tages angegeben werden. Bezüglich der Datum-Zeit Komponentenoptionen und der Stilschnellzugriffe (dateStyle und timeStyle), sollten die Optionen eine der folgenden Formen annehmen:

Keine davon anbieten: month und day werden standardmäßig als "numeric" gesetzt.
Nur dateStyle anbieten: es erweitert sich auf month und day Formate.
Einige Datum-Zeit Komponentenoptionen anbieten, wobei mindestens eine von ihnen month oder day ist. Nur die angegebenen Datumskomponenten werden in der Ausgabe enthalten sein.

Siehe den Intl.DateTimeFormat() Konstruktor für Details zu diesen Parametern und ihrer Verwendung.

Rückgabewert

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

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

Hinweis: In den meisten Fällen ist das Format, das von toLocaleString() zurückgegeben wird, konsistent. Es kann sich jedoch zwischen Implementierungen unterscheiden, selbst innerhalb derselben Locale — Abweichungen im Output sind absichtlich und durch die Spezifikation erlaubt. Der Ausgabe-String ist möglicherweise auch nicht das, was Sie erwarten. Beispielsweise könnte der String geschützte Leerzeichen verwenden oder von bidirektionalen Steuerzeichen umgeben sein. Sie sollten die Ergebnisse von toLocaleString() nicht mit hartcodierten Konstanten vergleichen.

Ausnahmen

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

Beispiele

Verwendung von toLocaleString()

Die grundlegende Nutzung dieser Methode ohne die Angabe eines locale gibt einen formatierten String in der Standard-Locale und 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 des locale übereinstimmt, auch wenn dessen Kalender iso8601 ist, muss explizit die 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 im Output enthalten sein sollen, indem Sie den options Parameter übergeben.

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