Temporal.Duration.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.Duration-Instanzen gibt einen String mit einer sprachsensitiven Darstellung dieser Dauer zurück. In Implementierungen mit Unterstützung für die Intl.DurationFormat API delegiert diese Methode an Intl.DurationFormat.
Jedes Mal, wenn toLocaleString aufgerufen wird, muss eine Suche in einer großen Datenbank von Lokalisierungs-Strings durchgeführt werden, was potenziell ineffizient ist. Wenn die Methode häufig mit denselben Argumenten aufgerufen wird, ist es besser, ein Intl.DurationFormat-Objekt zu erstellen und dessen format()-Methode zu verwenden, da ein DurationFormat-Objekt sich die übergebenen Argumente merkt und möglicherweise entscheidet, einen Teil der Datenbank zwischenzuspeichern. So können zukünftige format-Aufrufe Lokalisierungs-Strings in einem eingeschränkteren Kontext suchen.
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 festzulegen, deren Formatierungskonventionen verwendet werden sollen.
In Implementierungen, die die Intl.DurationFormat API unterstützen, entsprechen diese Parameter genau den Parametern des Intl.DurationFormat()-Konstruktors. Implementierungen ohne Unterstützung für Intl.DurationFormat geben denselben String zurück wie toString() und ignorieren beide Parameter.
localesOptional-
Ein String mit einem BCP 47-Sprachtag oder ein Array solcher Strings. Entspricht dem
locales-Parameter desIntl.DurationFormat()-Konstruktors. optionsOptional-
Ein Objekt, das das Ausgabeformat anpasst. Entspricht dem
options-Parameter desIntl.DurationFormat()-Konstruktors.
Siehe den Intl.DurationFormat()-Konstruktor für Details zu diesen Parametern und deren Verwendung.
Rückgabewert
Ein String, der die gegebene Dauer gemäß sprachspezifischen Konventionen darstellt.
In Implementierungen mit Intl.DurationFormat entspricht dies new Intl.DurationFormat(locales, options).format(duration).
Hinweis:
Meistens ist die Formatierung, die von toLocaleString() zurückgegeben wird, konsistent. Allerdings kann die Ausgabe je nach Implementierung variieren, selbst innerhalb derselben Locale — Ausgabevariationen sind absichtlich und werden von der Spezifikation erlaubt. Sie entspricht möglicherweise auch nicht Ihren Erwartungen. Beispielsweise kann der String geschützte Leerzeichen enthalten oder von bidirektionalen Steuerzeichen umgeben sein. Sie sollten die Ergebnisse von toLocaleString() nicht mit fest kodierten Konstanten vergleichen.
Beispiele
Verwendung von toLocaleString()
Die grundlegende Verwendung dieser Methode ohne Angabe einer locale gibt einen formatierten String in der Standard-Locale und mit Standardoptionen zurück.
const duration = Temporal.Duration.from({ hours: 1, minutes: 30, seconds: 15 });
console.log(duration.toLocaleString()); // 1 hr, 30 min, 15 sec
Spezifikationen
| Specification |
|---|
| Temporal # sec-temporal.duration.prototype.tolocalestring |