Temporal.PlainDateTime.prototype.toLocaleString()

可用性有限

此特性不是基线特性,因为它在一些最广泛使用的浏览器中不起作用。

实验性: 这是一项实验性技术
在生产中使用此技术之前,请仔细检查浏览器兼容性表格

Temporal.PlainDateTime 实例的 toLocaleString() 方法返回一个字符串,其中包含此日期时间的语言敏感表示。在支持 Intl.DateTimeFormat API 的实现中,此方法委托给 Intl.DateTimeFormat

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

语法

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

参数

localesoptions 参数自定义函数行为,并允许应用程序指定应使用的语言的格式约定。

在支持 Intl.DateTimeFormat API 的实现中,这些参数与 Intl.DateTimeFormat() 构造函数的参数完全对应。不支持 Intl.DateTimeFormat 的实现返回与 toString() 完全相同的字符串,忽略这两个参数。

locales 可选

一个带有 BCP 47 语言标签 的字符串,或此类字符串的数组。对应于 Intl.DateTimeFormat() 构造函数的 locales 参数。

options 可选

一个调整输出格式的对象。对应于 Intl.DateTimeFormat() 构造函数的 options 参数。如果此日期时间的日历不是 "iso8601",则必须提供具有相同值的 calendar 选项;否则,如果此日期时间的日历是 "iso8601",则 calendar 选项可以是任何值。关于日期时间组件选项和样式快捷方式(dateStyletimeStyle),这些选项应遵循以下形式之一:

  • 不提供任何选项:yearmonthdayhourminutesecond 将默认为 "numeric"
  • 提供至少一个 dateStyletimeStyle:日期时间组件将根据指定的样式和语言环境进行设置。
  • 提供一些日期时间组件选项。只有指定的日期时间组件将包含在输出中。

有关这些参数及其使用方法的详细信息,请参阅 Intl.DateTimeFormat() 构造函数

返回值

一个字符串,根据语言特定的约定表示给定的日期时间。

在支持 Intl.DateTimeFormat 的实现中,这等效于 new Intl.DateTimeFormat(locales, options).format(dateTime),其中 options 已按上述方式标准化。

注意: 大多数情况下,toLocaleString() 返回的格式是一致的。然而,输出在不同实现之间可能会有所不同,即使在相同的区域设置中也是如此——输出差异是设计使然,并受规范允许。它也可能不符合您的预期。例如,字符串可能使用不间断空格或被双向控制字符包围。您不应将 toLocaleString() 的结果与硬编码常量进行比较。

异常

RangeError

如果任何选项无效,则抛出。

TypeError

如果任何选项的类型不符合预期,则抛出。

示例

使用 toLocaleString()

不指定 locale 的此方法的简单用法以默认区域设置和默认选项返回格式化字符串。

js
const dt = Temporal.PlainDateTime.from("2021-08-01T12:34:56");

console.log(dt.toLocaleString()); // 8/1/2021, 12:34:56 PM (assuming en-US locale)

如果日期的日历与区域设置的默认日历不匹配,并且日期的日历不是 iso8601,则必须提供具有相同值的显式 calendar 选项。

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

使用带选项的 toLocaleString()

您可以通过提供 options 参数来自定义日期中包含在输出中的部分。

js
const dt = Temporal.PlainDateTime.from("2021-08-01T12:34:56");
dt.toLocaleString("en-US", { dateStyle: "full", timeStyle: "full" }); // Sunday, August 1, 2021 at 12:34:56 PM
dt.toLocaleString("en-US", {
  year: "numeric",
  month: "long",
  hour: "numeric",
}); // August 2021 at 12 PM
dt.toLocaleString("en-US", {
  year: "numeric",
  hour: "numeric",
  minute: "numeric",
}); // 2021, 12:34 PM

规范

规范
Temporal
# sec-temporal.plaindatetime.prototype.tolocalestring

浏览器兼容性

另见