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.
toLocaleDateString()
方法返回指定日期对象日期部分的字符串,该字符串格式因不同语言而不同。在支持 Intl.DateTimeFormat
API 的实现中,该方法仅是调用了 Intl.DateTimeFormat
方法。
尝试一下
语法
toLocaleDateString()
toLocaleDateString(locales)
toLocaleDateString(locales, options)
参数
locales
和 options
参数使程序能够指定使用哪种语言格式化规则,允许定制该方法的行为(behavior)。
在支持 Intl.DateTimeFormat
API 的实现中,这些参数与构造函数的参数完全对应。而对于不支持 Intl.DateTimeFormat
的实现,则要求函数忽略这两个参数,使得函数使用的区域(locale)以及返回的字符串的格式完全取决于实现。
locales
可选-
表示缩写语言代码(BCP 47 language tag)的字符串,或由此类字符串组成的数组。对应于
Intl.DateTimeFormat()
构造函数的locales
参数。在不支持
Intl.DateTimeFormat
的实现中,该参数会被忽略,并且通常会使用主机的区域设置。 options
可选-
一个调整输出格式的对象。对应于
Intl.DateTimeFormat()
构造函数的options
参数。如果其dayPeriod
、hour
、minute
、second
和fractionalSecondDigits
属性全是 undefined,则hour
、minute
、second
这三个属性会被设置为"numeric"
。在不支持
Intl.DateTimeFormat
的实现中,该参数会被忽略。
参见 Intl.DateTimeFormat()
构造函数以详细了解这些参数以及如何使用它们。
返回值
一个表示给定的 Date
实例的日期部分,且与语言相关的字符串。
在支持 Intl.DateTimeFormat
的实现中,该方法等价于 new Intl.DateTimeFormat(locales, options).format(date)
,其中的 options
已通过上述的规则进行规范化。
性能
当需要格式化大量的日期(date)时,最好创建一个 Intl.DateTimeFormat
对象,并使用其 format()
方法。
示例
使用 toLocaleDateString()
没有指定区域(locale)时,返回一个使用默认区域和格式设置(options)的格式化字符串。
const date = new Date(Date.UTC(2012, 11, 12, 3, 0, 0));
// toLocaleDateString() 不携带参数时,其默认区域和时区取决于实现
console.log(date.toLocaleDateString());
// "2012/12/12" 如果在 zh-CN 区域以及东八区(北京时间)下运行
检测 locales 和 options 参数支持情况
locales
和 options
参数不是所有的浏览器都支持。为了检测一种实现环境(implementation)是否支持它们,可以使用不合法的语言标签,如果实现环境支持该参数,则会抛出 RangeError
异常,反之会忽略参数。
function toLocaleDateStringSupportsLocales() {
try {
new Date().toLocaleDateString("i");
} catch (e) {
return e.name === "RangeError";
}
return false;
}
使用 locales
下例展示了本地化日期格式的一些变化。为了在应用的用户界面得到某种语言的日期格式,必须确保使用 locales
参数指定了该语言(可能还需要设置某些回退语言)。
const date = new Date(Date.UTC(2012, 11, 20, 3, 0, 0));
// 以下格式化输出均假设使用区域的本地时区;
// 对于美国,为 America/Los_Angeles
// 美式英语,使用 month-day-year 的顺序
console.log(date.toLocaleDateString("en-US"));
// "12/20/2012"
// 英式英语,使用 day-month-year 的顺序
console.log(date.toLocaleDateString("en-GB"));
// "20/12/2012"
// 韩国,使用 year-month-day 的顺序
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"));
// "۱۳۹۱/۹/۳۰"
// 大多数阿拉伯国家使用真正的阿拉伯数字
console.log(date.toLocaleDateString("ar-EG"));
// "٢٠/١٢/٢٠١٢"
// 对于日语,应用倾向于使用日本的和历,
// 2012 年是平成时代的第 24 年
console.log(date.toLocaleDateString("ja-JP-u-ca-japanese"));
// "24/12/20"
// 当使用的语言不被支持,例如
// 巴厘岛语,则可以包含一种回退语言,这里以印尼语为例
console.log(date.toLocaleDateString(["ban", "id"]));
// "20/12/2012"
使用 options
可以使用 options
参数来自定义 toLocaleDateString
方法返回的字符串。
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"
// 应用程序可能想要使用 UTC 时间,并使其可见
options.timeZone = "UTC";
options.timeZoneName = "short";
console.log(date.toLocaleDateString("en-US", options));
// "Thursday, December 20, 2012, UTC"
规范
Specification |
---|
ECMAScript Language Specification # sec-date.prototype.tolocaledatestring |
ECMAScript Internationalization API Specification # sup-date.prototype.tolocaledatestring |
浏览器兼容性
BCD tables only load in the browser