Temporal.PlainDate.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.PlainDate Instanzen gibt eine Zeichenkette mit einer sprachsensitiven Darstellung dieses Datums zurück. In Implementierungen mit Unterstützung für die Intl.DateTimeFormat API übergibt diese Methode an Intl.DateTimeFormat.

Jedes Mal, wenn toLocaleString aufgerufen wird, muss eine Suche in einer großen Datenbank von Lokalisierungszeichenketten 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 einen Teil der Datenbank zwischenspeichern kann, sodass zukünftige format Aufrufe Lokalisierungszeichenketten 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() Konstruktor. Implementierungen ohne Intl.DateTimeFormat Unterstützung 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. Wenn der Kalender dieses Datums nicht "iso8601" ist, muss die calendar Option mit demselben Wert angegeben werden; andernfalls kann die calendar Option bei einem "iso8601" Kalender jeden Wert haben. Hinsichtlich der Datetime-Komponenten-Optionen und der Stil-Abkürzungen (dateStyle und timeStyle) sollten die Optionen eine der folgenden Formen haben:

Keine angeben: year, month und day werden standardmäßig auf "numeric" gesetzt.
Nur dateStyle angeben: es wird auf weekday, era, year, month, und day Formate erweitert.
Einige Datumszeit-Komponenten-Optionen angeben, wobei mindestens eine davon eine Datumsoption (weekday, year, month, day) ist. Nur die angegebenen Datumskomponenten werden in die Ausgabe einbezogen.

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

Rückgabewert

Eine Zeichenkette, die das angegebene Datum gemäß sprachspezifischen Konventionen darstellt.

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

Hinweis: Meistens ist die durch toLocaleString() zurückgegebene Formatierung konsistent. Allerdings kann die Ausgabe zwischen Implementierungen unterschiedlich sein, selbst innerhalb derselben Sprache — Unterschiede in der Ausgabe sind bewusst und durch die Spezifikation erlaubt. Sie könnte auch nicht das sein, was Sie erwarten. Beispielsweise könnte die Zeichenkette geschützte Leerzeichen verwenden oder von bidirektionalen Steuerzeichen umgeben sein. Sie sollten die Ergebnisse von toLocaleString() nicht mit hart 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()

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

const date = Temporal.PlainDate.from("2021-08-01");

console.log(date.toLocaleString()); // 8/1/2021 (assuming en-US locale)

Falls der Kalender des Datums nicht mit dem Standardkalender der Sprache übereinstimmt und der Kalender des Datums nicht iso8601 ist, muss eine explizite calendar Option mit demselben Wert angegeben werden.

const date = Temporal.PlainDate.from("2021-08-01[u-ca=japanese]");
// The ja-JP locale uses the Gregorian calendar by default
date.toLocaleString("ja-JP", { calendar: "japanese" }); // R3/8/1

Verwendung von toLocaleString() mit Optionen

Sie können anpassen, welche Teile des Datums in der Ausgabe enthalten sein sollen, indem Sie den options Parameter angeben.

const date = Temporal.PlainDate.from("2021-08-01");
date.toLocaleString("en-US", { dateStyle: "full" }); // Sunday, August 1, 2021
date.toLocaleString("en-US", {
  year: "numeric",
  month: "long",
  day: "numeric",
}); // August 1, 2021
date.toLocaleString("en-US", { year: "numeric", month: "long" }); // August 2021

Spezifikationen

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

Browser-Kompatibilität

Siehe auch

Help improve MDN

Learn how to contribute Diese Seite wurde automatisch aus dem Englischen übersetzt.

Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden