Temporal.PlainTime.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.PlainTime-Instanzen gibt eine Zeichenkette mit einer sprachsensitiven Darstellung dieser Zeit 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 Lokalisierungszeichenfolgen 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 seine format()-Methode zu verwenden, da ein DateTimeFormat-Objekt sich die übergebenen Argumente merkt und möglicherweise ein Stück der Datenbank zwischenspeichert, sodass zukünftige format-Aufrufe innerhalb eines stärker eingeschränkten Kontexts nach Lokalisierungszeichenfolgen 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 zu spezifizieren, 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 dieselbe Zeichenkette zurück wie toString(), wobei beide Parameter ignoriert werden.

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. In Bezug auf die Datum-Zeit-Komponentenoptionen und die Stilkurzschlüsse (dateStyle und timeStyle) sollten die Optionen eine der folgenden Formen annehmen:

Keine von ihnen bereitstellen: hour, minute und second werden standardmäßig auf "numeric" gesetzt.
Nur timeStyle bereitstellen: Er erweitert sich auf dayPeriod, hour, minute, second und fractionalSecondDigits-Formate.
Einige Datum-Zeit-Komponentenoptionen bereitstellen, wobei mindestens eine davon eine Zeitoption ist (dayPeriod, hour, minute, second, fractionalSecondDigits). Nur die angegebenen Zeitkomponenten werden in die Ausgabe einbezogen.

Details zu diesen Parametern und ihrer Verwendung finden Sie im Intl.DateTimeFormat()-Konstruktor.

Rückgabewert

Eine Zeichenkette, die die gegebene Zeit entsprechend sprachspezifischen Konventionen darstellt.

In Implementierungen mit Intl.DateTimeFormat entspricht dies new Intl.DateTimeFormat(locales, options).format(time), 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 — Ausgabeabweichungen sind durch das Design und die Spezifikation erlaubt. Es könnte auch nicht das sein, was Sie erwarten. Zum Beispiel könnte die Zeichenkette 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 vom erwarteten Typ ist.

Beispiele

Verwendung von toLocaleString()

Die grundlegende Verwendung dieser Methode ohne Angabe einer locale gibt eine formatierte Zeichenkette in der Standardsprache und mit Standardoptionen zurück.

const time = Temporal.PlainTime.from("12:34:56");

console.log(time.toLocaleString()); // 12:34:56 PM (assuming en-US locale)

Verwendung von toLocaleString() mit Optionen

Sie können anpassen, welche Teile der Zeit in der Ausgabe enthalten sein sollen, indem Sie den options-Parameter bereitstellen.

const time = Temporal.PlainTime.from("12:34:56");
time.toLocaleString("en-US", { timeStyle: "short" }); // 12:34 PM
time.toLocaleString("en-US", { hour: "2-digit" }); // 12 PM

Spezifikationen

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