Temporal.PlainYearMonth.prototype.toJSON()

main Documentación oficial Licencia CC-BY-SA-2.5Descargado el 2026-08-02

En esta página

Syntax#
Parameters#
Return value#
Description#
Examples#
Using toJSON()#
JSON serialization and parsing#
Specifications#
Browser compatibility#
See also#

The toJSON() method of {{jsxref("Temporal.PlainYearMonth")}} instances returns a string representing this year-month in the same RFC 9557 format as calling {{jsxref("Temporal/PlainYearMonth/toString", "toString()")}}. It is intended to be implicitly called by {{jsxref("JSON.stringify()")}}.

Syntax#

toJSON()

Parameters#

None.

Return value#

A string representing the given date in the RFC 9557 format, with the calendar annotation included if it is not "iso8601".

Description#

The toJSON() method is automatically called by {{jsxref("JSON.stringify()")}} when a Temporal.PlainYearMonth object is stringified. This method is generally intended to, by default, usefully serialize Temporal.PlainYearMonth objects during JSON serialization, which can then be deserialized using the {{jsxref("Temporal/PlainYearMonth/from", "Temporal.PlainYearMonth.from()")}} function as the reviver of {{jsxref("JSON.parse()")}}.

Examples#

Using toJSON()#

const ym = Temporal.PlainYearMonth.from({ year: 2021, month: 8 });
const ymStr = ym.toJSON(); // '2021-08'
const ym2 = Temporal.PlainYearMonth.from(ymStr);

JSON serialization and parsing#

This example shows how Temporal.PlainYearMonth can be serialized as JSON without extra effort, and how to parse it back.

const ym = Temporal.PlainYearMonth.from({ year: 2021, month: 8 });
const ymStr = JSON.stringify({ event: ym }); // '{"event":"2021-08"}'
const obj = JSON.parse(ymStr, (key, value) => {
  if (key === "event") {
    return Temporal.PlainYearMonth.from(value);
  }
  return value;
});