Date.prototype.toLocaleDateString()
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2017.
Die Methode toLocaleDateString()
von Date
Instanzen gibt einen String mit einer sprachsensitiven Darstellung des Datumsanteils dieses Datums in der lokalen Zeitzone zurück. In Implementierungen mit Unterstützung der Intl.DateTimeFormat
API delegiert diese Methode an Intl.DateTimeFormat
.
Jedes Mal, wenn toLocaleString
aufgerufen wird, muss in einer großen Datenbank von Lokalisierungsstrings gesucht werden, was potenziell ineffizient ist. Wenn die Methode viele Male mit den gleichen 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 möglicherweise entscheidet, einen Teil der Datenbank im Cache zu speichern, sodass zukünftige format
Aufrufe Lokalisierungsstrings in einem engeren Kontext suchen können.
Probieren Sie es aus
const event = new Date(Date.UTC(2012, 11, 20, 3, 0, 0));
const options = {
weekday: "long",
year: "numeric",
month: "long",
day: "numeric",
};
console.log(event.toLocaleDateString("de-DE", options));
// Expected output (varies according to local timezone): Donnerstag, 20. Dezember 2012
console.log(event.toLocaleDateString("ar-EG", options));
// Expected output (varies according to local timezone): الخميس، ٢٠ ديسمبر، ٢٠١٢
console.log(event.toLocaleDateString(undefined, options));
// Expected output (varies according to local timezone and default locale): Thursday, December 20, 2012
Syntax
toLocaleDateString()
toLocaleDateString(locales)
toLocaleDateString(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()
Konstruktors. Implementierungen ohne Unterstützung für Intl.DateTimeFormat
werden gebeten, beide Parameter zu ignorieren, sodass die verwendete Locale und die Form des zurückgegebenen Strings vollständig implementierungsabhängig sind.
locales
Optional-
Ein String mit einem BCP 47 Sprach-Tag oder ein Array solcher Strings. Entspricht dem
locales
Parameter desIntl.DateTimeFormat()
Konstruktors.In Implementierungen ohne Unterstützung für
Intl.DateTimeFormat
wird dieser Parameter ignoriert und üblicherweise die Locale des Hosts verwendet. options
Optional-
Ein Objekt, das das Ausgabeformat anpasst. Entspricht dem
options
Parameter desIntl.DateTimeFormat()
Konstruktors. DietimeStyle
Option muss undefiniert sein, ansonsten würde einTypeError
ausgelöst. Wennweekday
,year
,month
undday
alle undefiniert sind, werdenyear
,month
undday
auf"numeric"
gesetzt.In Implementierungen ohne Unterstützung für
Intl.DateTimeFormat
wird dieser Parameter ignoriert.
Siehe den Intl.DateTimeFormat()
Konstruktor für Details zu diesen Parametern und wie man sie verwendet.
Rückgabewert
Ein String, der den Datumsanteil des angegebenen Datums 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 Formatierung, die von toLocaleDateString()
zurückgegeben wird, konsistent. Allerdings kann die Ausgabe zwischen verschiedenen Implementierungen variieren, selbst innerhalb derselben Locale — Ausgabeunterschiede sind designbedingt und durch die Spezifikation erlaubt. Es kann auch sein, dass es nicht das ist, was Sie erwarten. Beispielsweise kann der String geschützte Leerzeichen verwenden oder von bidirektionalen Steuerzeichen umgeben sein. Sie sollten die Ergebnisse von toLocaleDateString()
nicht mit hartcodierten Konstanten vergleichen.
Beispiele
Verwendung von toLocaleDateString()
Die grundlegende Verwendung dieser Methode ohne Angabe einer locale
gibt einen formatierten String in der Standardsprache und mit Standardoptionen zurück.
const date = new Date(Date.UTC(2012, 11, 12, 3, 0, 0));
// toLocaleDateString() without arguments depends on the implementation,
// the default locale, and the default time zone
console.log(date.toLocaleDateString());
// "12/11/2012" if run in en-US locale with time zone America/Los_Angeles
Überprüfen der Unterstützung für die Parameter locales und options
Die locales
und options
Parameter werden möglicherweise nicht in allen Implementierungen unterstützt, da die Unterstützung für die Internationalisierungs-API optional ist und einige Systeme möglicherweise nicht über die erforderlichen Daten verfügen. Für Implementierungen ohne Unterstützung für Internationalisierung verwendet toLocaleDateString()
immer die Locale des Systems, was möglicherweise nicht das ist, was Sie wollen. Da jede Implementierung, die die locales
und options
Parameter unterstützt, die Intl
API unterstützen muss, können Sie das Vorhandensein letzterer zur Unterstützung überprüfen:
function toLocaleDateStringSupportsLocales() {
return (
typeof Intl === "object" &&
!!Intl &&
typeof Intl.DateTimeFormat === "function"
);
}
Verwendung von locales
Dieses Beispiel zeigt einige der Variationen in lokalisierten Datumsformaten. Um das Format der in der Benutzeroberfläche Ihrer Anwendung verwendeten Sprache zu erhalten, stellen Sie sicher, dass Sie diese Sprache (und möglicherweise einige Fallback-Sprachen) mit dem locales
Argument angeben:
const date = new Date(Date.UTC(2012, 11, 20, 3, 0, 0));
// formats below assume the local time zone of the locale;
// America/Los_Angeles for the US
// US English uses month-day-year order
console.log(date.toLocaleDateString("en-US"));
// "12/20/2012"
// British English uses day-month-year order
console.log(date.toLocaleDateString("en-GB"));
// "20/12/2012"
// Korean uses year-month-day order
console.log(date.toLocaleDateString("ko-KR"));
// "2012. 12. 20."
// Event for Persian, It's hard to manually convert date to Solar Hijri
console.log(date.toLocaleDateString("fa-IR"));
// "۱۳۹۱/۹/۳۰"
// Arabic in most Arabic speaking countries uses real Arabic digits
console.log(date.toLocaleDateString("ar-EG"));
// "٢٠/١٢/٢٠١٢"
// for Japanese, applications may want to use the Japanese calendar,
// where 2012 was the year 24 of the Heisei era
console.log(date.toLocaleDateString("ja-JP-u-ca-japanese"));
// "24/12/20"
// when requesting a language that may not be supported, such as
// Balinese, include a fallback language, in this case Indonesian
console.log(date.toLocaleDateString(["ban", "id"]));
// "20/12/2012"
Verwendung von options
Die Ergebnisse, die von toLocaleDateString()
bereitgestellt werden, können mit dem options
Parameter angepasst werden:
const date = new Date(Date.UTC(2012, 11, 20, 3, 0, 0));
// Request a weekday along with a long date
const options = {
weekday: "long",
year: "numeric",
month: "long",
day: "numeric",
};
console.log(date.toLocaleDateString("de-DE", options));
// "Donnerstag, 20. Dezember 2012"
// An application may want to use UTC and make that visible
options.timeZone = "UTC";
options.timeZoneName = "short";
console.log(date.toLocaleDateString("en-US", options));
// "Thursday, December 20, 2012, UTC"
Spezifikationen
Specification |
---|
ECMAScript® 2025 Language Specification # sec-date.prototype.tolocaledatestring |
ECMAScript® 2025 Internationalization API Specification # sup-date.prototype.tolocaledatestring |