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 einen String zurück, der eine sprachenspezifische Darstellung dieser Zeit bietet. 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 mehrfach 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 entscheidet, einen Ausschnitt der Datenbank zu cachen, sodass zukünftige format Aufrufe innerhalb eines engeren Kontextes nach Lokalisierungsstrings suchen können.

Syntax

js
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 Intl.DateTimeFormat Unterstützung geben genau denselben String 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, das das Ausgabeformat anpasst. Entspricht dem options Parameter des Intl.DateTimeFormat() Konstruktors. In Bezug auf die Datum-Zeit-Komponentenoptionen und die Stil-Kurzformen (dateStyle und timeStyle), sollten die Optionen eine der folgenden Formen aufweisen:

  • Keine von ihnen bereitstellen: hour, minute und second werden auf "numeric" standardisiert.
  • Nur timeStyle bereitstellen: Es umfasst 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 der Ausgabe enthalten sein.

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

Rückgabewert

Ein String, der die gegebene Zeit gemäß sprachenspezifischer Konventionen darstellt.

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

Hinweis: Meistens ist das vom toLocaleString() zurückgegebene Format konsistent. Allerdings kann die Ausgabe zwischen Implementierungen variieren, sogar innerhalb derselben Lokalisierung — Ausgabevariationen sind vorgesehen und durch die Spezifikation erlaubt. Es kann auch nicht dem entsprechen, was Sie erwarten. Zum Beispiel kann der String geschützte Leerzeichen verwenden oder von bidirektionalen Steuerzeichen umgeben sein. Sie sollten die Ergebnisse von toLocaleString() nicht mit fest kodierten 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()

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

js
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 die Ausgabe eingeschlossen werden, indem Sie den options Parameter bereitstellen.

js
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 proposal
# sec-temporal.plaintime.prototype.tolocalestring

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch