Temporal.PlainMonthDay.prototype.toLocaleString()
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Die toLocaleString() Methode von Temporal.PlainMonthDay Instanzen gibt eine zeichenfolgenbasierte, sprachsensitive Darstellung dieses Monats-Tages zurück. In Implementierungen mit Unterstützung für die Intl.DateTimeFormat API delegiert diese Methode an Intl.DateTimeFormat.
Jedes Mal, wenn toLocaleString aufgerufen wird, muss in einer großen Datenbank von Lokalisierungsstrings gesucht 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 gegebenenfalls entscheiden kann, einen Teil der Datenbank im Cache zu behalten, sodass zukünftige format Aufrufe Lokalisierungsstrings in einem eingeschränkteren Kontext suchen können.
Syntax
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.DateTimeFormat API unterstützen, entsprechen diese Parameter genau den Parametern des Intl.DateTimeFormat() Konstruktors. Implementierungen ohne Intl.DateTimeFormat Unterstützung geben exakt den gleichen String wie toString() zurück und ignorieren beide Parameter.
localesOptional-
Ein String mit einem BCP 47 Sprach-Tag oder ein Array solcher Strings. Entspricht dem
localesParameter desIntl.DateTimeFormat()Konstruktors. optionsOptional-
Ein Objekt, das das Ausgabeformat anpasst. Entspricht dem
optionsParameter desIntl.DateTimeFormat()Konstruktors. DiecalendarOption muss mit dem gleichen Wert wie der Kalender dieses Monats-Tages angegeben werden. Bezüglich der Datum-Zeit-Komponentenoptionen und der Stil-Abkürzungen (dateStyleundtimeStyle) sollten die Optionen eine der folgenden Formen haben:- Keine davon angeben:
monthunddaywerden auf"numeric"voreingestellt. - Nur
dateStyleangeben: es wird aufmonthunddayFormate erweitert. - Einige Datum-Zeit-Komponentenoptionen angeben, wobei mindestens eine
monthoderdayist. Nur die angegebenen Datumskomponenten werden in die Ausgabe aufgenommen.
- Keine davon angeben:
Details zu diesen Parametern und deren Verwendung finden Sie im Intl.DateTimeFormat() Konstruktor.
Rückgabewert
Ein String, der den gegebenen 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:
Meistens ist das von toLocaleString() zurückgegebene Format konsistent. Die Ausgabe kann jedoch je nach Implementierung variieren, selbst innerhalb derselben Lokalisierung — Ausgabenabweichungen sind vom Design her erlaubt und durch die Spezifikation festgelegt. Es könnte auch nicht das sein, was Sie erwarten. Beispielsweise kann die Zeichenfolge geschützte Leerzeichen 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 vom erwarteten Typ ist.
Beispiele
Verwendung von toLocaleString()
Die grundlegende Verwendung dieser Methode ohne Angabe eines locale gibt einen formatierten String in der Standardsprache 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 der Lokalisierung übereinstimmt, selbst wenn sein Kalender iso8601 ist, muss 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 |