NotRestoredReasonDetails: toJSON() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Want more browser support for this feature? Tell us why.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The toJSON() method of the NotRestoredReasonDetails interface returns a JSON-serializable plain object representing the NotRestoredReasonDetails object.

The method is automatically called by JSON.stringify() when a NotRestoredReasonDetails object is encountered during JSON serialization.

Syntax

js
toJSON()

Parameters

None.

Return value

A JSON-serializable plain object containing the following properties:

Each property's value is copied as-is.

Examples

Calling toJSON() directly

This example obtains a NotRestoredReasonDetails object from the first navigation entry. Calling toJSON() directly returns a plain object. Its properties have the same values as the corresponding properties of the original object.

js
const navEntries = performance.getEntriesByType("navigation");
const navEntry = navEntries[0];
const reason = navEntry.notRestoredReasons.reasons[0];

const json = reason.toJSON();
console.log(json); // A plain object
console.log(typeof json); // "object"
console.log(json.reason); // Same value as reason.reason

Serializing to a JSON string

The object from the previous example is serialized using JSON.stringify(), which calls the toJSON() method automatically.

js
console.log(JSON.stringify(reason));

This would log a JSON string like so (formatted for readability):

json
{
  "reason": "masked"
}

Specifications

Specification
HTML
# notrestoredreasondetails

Browser compatibility

See also