Date.prototype.toLocaleString()

基线 广泛可用

此功能已得到良好确立，并在许多设备和浏览器版本上都能正常工作。它已在浏览器中提供，自 2017 年 9 月.

toLocaleString() 方法是 Date 实例的方法，它返回一个字符串，其中包含此日期在本地时区的语言敏感表示形式。在支持 Intl.DateTimeFormat API 的实现中，此方法只需调用 Intl.DateTimeFormat。

每次调用 toLocaleString 时，它都必须在一个大型的本地化字符串数据库中执行搜索，这可能会降低效率。当使用相同参数多次调用该方法时，最好创建一个 Intl.DateTimeFormat 对象并使用其 format() 方法，因为 DateTimeFormat 对象会记住传递给它的参数，并可能决定缓存数据库的一部分，以便将来 format 调用可以在更受约束的上下文中搜索本地化字符串。

试一试

语法

js
toLocaleString()
toLocaleString(locales)
toLocaleString(locales, options)

参数

locales 和 options 参数自定义函数的行为，并允许应用程序指定应使用其格式约定进行格式化的语言。

在支持 Intl.DateTimeFormat API 的实现中，这些参数与 Intl.DateTimeFormat() 构造函数的参数完全一致。不支持 Intl.DateTimeFormat 的实现被要求忽略这两个参数，这使得所使用的语言环境和返回的字符串形式完全取决于实现。

locales 可选

包含 BCP 47 语言标记的字符串，或此类字符串的数组。对应于 Intl.DateTimeFormat() 构造函数的 locales 参数。

在不支持 Intl.DateTimeFormat 的实现中，此参数将被忽略，通常使用主机的语言环境。

options 可选

用于调整输出格式的对象。对应于 Intl.DateTimeFormat() 构造函数的 options 参数。如果 weekday、year、month、day、dayPeriod、hour、minute、second 和 fractionalSecondDigits 全部未定义，则 year、month、day、hour、minute、second 将设置为 "numeric"。

在不支持 Intl.DateTimeFormat 的实现中，此参数将被忽略。

有关这些参数以及如何使用它们的详细信息，请参阅 Intl.DateTimeFormat() 构造函数。

返回值

根据特定于语言的约定表示给定日期的字符串。

在支持 Intl.DateTimeFormat 的实现中，这等效于 new Intl.DateTimeFormat(locales, options).format(date)。

注意： 大多数情况下，toLocaleString() 返回的格式是一致的。但是，输出可能在实现之间有所不同，即使在同一语言环境中也是如此——输出差异是设计使然，并且规范允许。它也可能与您期望的不同。例如，该字符串可能使用不换行空格或被双向控制字符包围。您不应将 toLocaleString() 的结果与硬编码常量进行比较。

示例

使用 toLocaleString()

此方法的基本用法，不指定 locale，将在默认语言环境和默认选项下返回格式化的字符串。

js
const date = new Date(Date.UTC(2012, 11, 12, 3, 0, 0));

// toLocaleString() without arguments depends on the
// implementation, the default locale, and the default time zone
console.log(date.toLocaleString());
// "12/11/2012, 7:00:00 PM" if run in en-US locale with time zone America/Los_Angeles

检查对 locales 和 options 参数的支持

locales 和 options 参数可能并非在所有实现中都受支持，因为对国际化 API 的支持是可选的，并且某些系统可能没有必要的数据。对于没有国际化支持的实现，toLocaleString() 始终使用系统的语言环境，这可能不是您想要的。因为任何支持 locales 和 options 参数的实现都必须支持 Intl API，因此您可以检查后者的存在以确认支持情况

js
function toLocaleStringSupportsLocales() {
  return (
    typeof Intl === "object" &&
    !!Intl &&
    typeof Intl.DateTimeFormat === "function"
  );
}

使用 locales

此示例显示了本地化日期和时间格式的一些变化。为了获取应用程序用户界面中使用的语言的格式，请确保使用 locales 参数指定该语言（以及一些备用语言）

js
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 and 12-hour time with AM/PM
console.log(date.toLocaleString("en-US"));
// "12/19/2012, 7:00:00 PM"

// British English uses day-month-year order and 24-hour time without AM/PM
console.log(date.toLocaleString("en-GB"));
// "20/12/2012 03:00:00"

// Korean uses year-month-day order and 12-hour time with AM/PM
console.log(date.toLocaleString("ko-KR"));
// "2012. 12. 20. 오후 12:00:00"

// Arabic in most Arabic-speaking countries uses Eastern Arabic numerals
console.log(date.toLocaleString("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.toLocaleString("ja-JP-u-ca-japanese"));
// "24/12/20 12:00:00"

// When requesting a language that may not be supported, such as
// Balinese, include a fallback language (in this case, Indonesian)
console.log(date.toLocaleString(["ban", "id"]));
// "20/12/2012 11.00.00"

使用 options

可以使用 options 参数自定义 toLocaleString() 提供的结果

js
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.toLocaleString("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.toLocaleString("en-US", options));
// "Thursday, December 20, 2012, GMT"

// Sometimes even the US needs 24-hour time
console.log(date.toLocaleString("en-US", { hour12: false }));
// "12/19/2012, 19:00:00"

规范

规范
ECMAScript 语言规范
# sec-date.prototype.tolocalestring
ECMAScript 国际化 API 规范
# sup-date.prototype.tolocalestring

浏览器兼容性

BCD 表仅在启用 JavaScript 的浏览器中加载。

另请参阅