The withCalendar() method of Temporal.PlainDate instances returns a new Temporal.PlainDate object representing this date interpreted in the new calendar system. Because all Temporal objects are designed to be immutable, this method essentially functions as the setter for the date's Temporal/PlainDate/calendarId property.
To replace the date component properties, use the Temporal/PlainDate/with method instead.
Syntax
withCalendar(calendar)
Parameters
calendar- : A string that corresponds to the Temporal/PlainDate/calendarId property. See
Intl.supportedValuesOf()for a list of commonly supported calendar types.
- : A string that corresponds to the Temporal/PlainDate/calendarId property. See
Return value
A new Temporal.PlainDate object, representing the date specified by the original PlainDate, interpreted in the new calendar system.
Exceptions
- TypeError
- : Thrown if
calendaris not a string.
- : Thrown if
- RangeError
- : Thrown if
calendaris not a valid calendar identifier.
- : Thrown if
Examples
Using withCalendar()
const date = Temporal.PlainDate.from("2021-07-01");
const newDate = date.withCalendar("islamic-umalqura");
console.log(newDate.toLocaleString("en-US", { calendar: "islamic-umalqura" }));
// 11/21/1442 AH
Specifications
Browser compatibility
See also
- Temporal.PlainDate
- Temporal/PlainDate/with
- Temporal/PlainDate/from
- Temporal/PlainDate/calendarId
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
