Temporal.PlainDate.prototype.with()

可用性有限

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

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

with() 方法用于 Temporal.PlainDate 实例,它会返回一个新的 Temporal.PlainDate 对象,该对象表示此日期,并用新值替换了其中的某些字段。由于所有 Temporal 对象都设计为不可变的,因此此方法实际上充当了日期字段的设置器。

要替换 calendarId 属性,请改用 withCalendar() 方法。

语法

js
with(info)
with(info, options)

参数

info

一个包含 Temporal.PlainDate.from() 识别的至少一个属性(除了 calendar)的对象:dayeraeraYearmonthmonthCodeyear。未指定的属性将使用原始日期中的值。您只需要提供 monthmonthCode 中的一个,以及 eraeraYearyear 中的一个,其他字段将相应更新。

options 可选

包含以下属性的对象

overflow 可选

一个字符串,指定日期组件超出范围时的行为。可能的值是

"constrain"(默认)

日期组件被限制在有效范围内。

"reject"

如果日期组件超出范围,则抛出 RangeError

返回值

一个新的 Temporal.PlainDate 对象,其中 info 中指定的、非 undefined 的字段将被相应的值替换,其余字段将从原始日期复制。

异常

TypeError

在以下情况之一中抛出

  • info 不是一个对象。
  • options 不是对象或 undefined
RangeError

在以下情况之一中抛出

  • 指定相同组件的提供的属性不一致。
  • 提供的非数字属性无效;例如,如果 monthCode 在此日历中从未是有效的月份代码。
  • 提供的数字属性超出范围,并且 options.overflow 设置为 "reject"
  • 结果不在可表示范围内,该范围是距 Unix 纪元 ±(108 + 1) 天,约 ±273,972.6 年。

示例

使用 with()

js
const date = Temporal.PlainDate.from("2021-07-06");
const newDate = date.with({ day: date.daysInMonth });
console.log(newDate.toString()); // 2021-07-31
const nextDecade = date.with({ year: date.year + 10 });
console.log(nextDecade.toString()); // 2031-07-06

有关更多示例,请参阅可以使用 with() 设置的各个属性的文档。

规范

规范
Temporal
# sec-temporal.plaindate.prototype.with

浏览器兼容性

另见