Temporal.PlainDate.prototype.toString()
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 toString() method of Temporal.PlainDate instances returns a string representing this date in the RFC 9557 format.
Syntax
toString()
toString(options)
Parameters
optionsOptional-
An object containing the following property:
calendarNameOptional-
Whether to show the calendar annotation (
[u-ca=calendar_id]) in the return value. Possible values are:"auto"(default)-
Include the calendar annotation if the calendar is not
"iso8601". "always"-
Always include the calendar annotation.
"never"-
Never include the calendar annotation. This makes the returned string not recoverable to the same
Temporal.PlainDateinstance, although the date value still remains the same. "critical"-
Always include the calendar annotation, and add a critical flag:
[!u-ca=calendar_id]. Useful when sending the string to certain systems, but not useful for Temporal itself.
Return value
A string in the RFC 9557 format representing this date. The calendar annotation is included as specified.
Exceptions
RangeError-
Thrown if any of the options is invalid.
TypeError-
Thrown if
optionsis not an object orundefined.
Examples
Using toString()
const date = Temporal.PlainDate.from("2021-08-01");
console.log(date.toString()); // '2021-08-01'
Using options
const isoDate = Temporal.PlainDate.from({ year: 2021, month: 8, day: 1 });
const date = Temporal.PlainDate.from({
year: 2021,
month: 8,
day: 1,
calendar: "islamic-umalqura",
});
console.log(isoDate.toString({ calendarName: "auto" })); // '2021-08-01'
console.log(date.toString({ calendarName: "auto" })); // '2582-12-17[u-ca=islamic-umalqura]'
console.log(isoDate.toString({ calendarName: "always" })); // '2021-08-01[u-ca=iso8601]'
console.log(date.toString({ calendarName: "always" })); // '2582-12-17[u-ca=islamic-umalqura]'
console.log(date.toString({ calendarName: "never" })); // '2582-12-17'
console.log(isoDate.toString({ calendarName: "critical" })); // '2021-08-01[!u-ca=iso8601]'
console.log(date.toString({ calendarName: "critical" })); // '2582-12-17[!u-ca=islamic-umalqura]'
Specifications
| Specification |
|---|
| Temporal # sec-temporal.plaindate.prototype.tostring |
Browser compatibility
Loading…