Temporal.PlainDate.prototype.withCalendar()
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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 calendarId property.
To replace the date component properties, use the with() method instead.
Syntax
withCalendar(calendar)
Parameters
calendar-
A string that corresponds to the
calendarIdproperty. SeeIntl.supportedValuesOf()for a list of commonly supported calendar types.
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. RangeError-
Thrown if
calendaris not a valid calendar identifier.
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
| Specification |
|---|
| Temporal # sec-temporal.plaindate.prototype.withcalendar |
Browser compatibility
Loading…