Temporal.Instant.prototype.toJSON()

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 toJSON() method of Temporal.Instant instances returns a string representing this instant in the same RFC 9557 format as calling toString(). It is intended to be implicitly called by JSON.stringify().

Syntax

toJSON()

Parameters

None.

Return value

A string representing the given instant in the RFC 9557 format, with as much subsecond precision as necessary to represent the duration accurately, and with the UTC time zone designator Z.

Description

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

Examples

Using toJSON()

const instant = Temporal.Instant.fromEpochMilliseconds(1627821296000);
const instantStr = instant.toJSON(); // '2021-08-01T12:34:56Z'
const i2 = Temporal.Instant.from(instantStr);

JSON serialization and parsing

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

const instant = Temporal.Instant.fromEpochMilliseconds(1627821296000);
const jsonStr = JSON.stringify({ time: instant }); // '{"time":"2021-08-01T12:34:56Z"}'
const obj = JSON.parse(jsonStr, (key, value) => {
  if (key === "time") {
    return Temporal.Instant.from(value);
  }
  return value;
});

Specifications

Specification
Temporal # sec-temporal.instant.prototype.tojson

Browser compatibility

	Desktop					Mobile						Server
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet	WebView Android	Deno	Node.js
`toJSON`	No	No	139	No	preview	No	139	No	No	No	No	1.40	No