Temporal.PlainDateTime.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.PlainDateTime-Instanzen gibt eine zeichenkettenbasierte, sprachabhängige Darstellung dieser Datum-Uhrzeit 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 eine Suche in einer großen Datenbank von Lokalisierungsstrings durchgeführt werden, was potenziell ineffizient ist. Wenn die Methode oft mit denselben Argumenten aufgerufen wird, ist es besser, ein Intl.DateTimeFormat-Objekt zu erstellen und seine format()-Methode zu verwenden, da ein DateTimeFormat-Objekt sich die übergebenen Argumente merkt und möglicherweise einen Teil der Datenbank zwischenspeichert, sodass zukünftige format-Aufrufe Lokalisierungsstrings in einem engeren 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 zu spezifizieren, 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.
localesOptional-
Ein String mit einem BCP 47-Sprach-Tag, oder ein Array solcher Strings. Entspricht dem
locales-Parameter desIntl.DateTimeFormat()-Konstruktors. optionsOptional-
Ein Objekt, das das Ausgabeformat anpasst. Entspricht dem
options-Parameter desIntl.DateTimeFormat()-Konstruktors. Wenn dieser Kalender der Datum-Uhrzeit nicht"iso8601"ist, muss diecalendar-Option mit demselben Wert angegeben werden; andernfalls kann bei einem"iso8601"-Kalender diecalendar-Option einen beliebigen Wert haben. Bezüglich der Datum-Uhrzeit-Komponentenoptionen und den Stilabkürzungen (dateStyleundtimeStyle) sollten die Optionen einen der folgenden Formen folgen:- Keine von ihnen bereitstellen:
year,month,day,hour,minuteundsecondwerden standardmäßig auf"numeric"gesetzt. - Mindestens eine von
dateStyleodertimeStylebereitstellen: Die Datum-Uhrzeit-Komponenten werden gemäß dem angegebenen Stil und der Locale gesetzt. - Einige Datum-Uhrzeit-Komponentenoptionen bereitstellen. Nur die angegebenen Datum-Uhrzeit-Komponenten werden in der Ausgabe enthalten sein.
- Keine von ihnen bereitstellen:
Siehe den Intl.DateTimeFormat()-Konstruktor für Details zu diesen Parametern und ihrer Verwendung.
Rückgabewert
Eine Zeichenkette, die die gegebene Datum-Uhrzeit gemäß sprachspezifischen Konventionen darstellt.
In Implementierungen mit Intl.DateTimeFormat entspricht dies new Intl.DateTimeFormat(locales, options).format(dateTime), wobei options wie oben beschrieben normalisiert wurde.
Hinweis:
Meistens ist das von toLocaleString() zurückgegebene Format konsistent. Der Output kann jedoch zwischen Implementierungen variieren, selbst innerhalb derselben Locale — Abweichungen sind vom Design vorgesehen und laut der Spezifikation zulässig. Es kann auch nicht dem entsprechen, was Sie erwarten. Die Zeichenfolge könnte zum Beispiel geschützte Leerzeichen verwenden oder von bidirektionalen Steuerungszeichen umgeben sein. Sie sollten die Ergebnisse von toLocaleString() nicht mit fest einprogrammierten 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()
Die grundlegende Verwendung dieser Methode ohne Angabe eines locale gibt eine formatierte Zeichenkette in der Standard-Locale und mit Standardoptionen zurück.
const dt = Temporal.PlainDateTime.from("2021-08-01T12:34:56");
console.log(dt.toLocaleString()); // 8/1/2021, 12:34:56 PM (assuming en-US locale)
Wenn der Kalender des Datums nicht mit dem Standardkalender der Locale übereinstimmt und der Kalender des Datums nicht iso8601 ist, muss explizit eine calendar-Option mit demselben Wert angegeben werden.
const dt = Temporal.PlainDateTime.from("2021-08-01T12:34:56[u-ca=japanese]");
// The ja-JP locale uses the Gregorian calendar by default
dt.toLocaleString("ja-JP", { calendar: "japanese" }); // R3/8/1 12:34:56
Verwendung von toLocaleString() mit Optionen
Sie können anpassen, welche Teile des Datums in der Ausgabe enthalten sind, indem Sie den options-Parameter angeben.
const dt = Temporal.PlainDateTime.from("2021-08-01T12:34:56");
dt.toLocaleString("en-US", { dateStyle: "full", timeStyle: "full" }); // Sunday, August 1, 2021 at 12:34:56 PM
dt.toLocaleString("en-US", {
year: "numeric",
month: "long",
hour: "numeric",
}); // August 2021 at 12 PM
dt.toLocaleString("en-US", {
year: "numeric",
hour: "numeric",
minute: "numeric",
}); // 2021, 12:34 PM
Spezifikationen
| Specification |
|---|
| Temporal # sec-temporal.plaindatetime.prototype.tolocalestring |
Browser-Kompatibilität
Loading…