GeolocationPosition: toJSON() method

فهرست فصل‌ها دانلود آرشیوناشر

MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونه‌کد

{{APIRef("Geolocation API")}}

The **toJSON()** method of the {{domxref("GeolocationPosition")}} interface returns a JSON-serializable plain object representing the GeolocationPosition object.

The method is automatically called by {{jsxref("JSON.stringify()")}} when a GeolocationPosition object is encountered during JSON serialization.

Syntax

js-nolint
toJSON()

Parameters

None.

Return value

A JSON-serializable plain object containing the following properties:

  • {{domxref("GeolocationPosition/timestamp", "timestamp")}}
  • {{domxref("GeolocationPosition/coords", "coords")}}

Each property's value is copied as-is. When the returned object is passed to {{jsxref("JSON.stringify()")}}, the coords property is further serialized using {{domxref("GeolocationCoordinates/toJSON", "GeolocationCoordinates.toJSON()")}}.

Examples

Calling toJSON() directly

This example obtains a GeolocationPosition object. Calling toJSON() directly returns a plain object. Its properties have the same values as the corresponding properties of the original object.

js
navigator.geolocation.getCurrentPosition((position) => {
  const json = position.toJSON();
  console.log(json); // A plain object
  console.log(typeof json); // "object"
  console.log(json.timestamp); // Same value as position.timestamp
});

Serializing to a JSON string

Within the callback from the previous example, the same object can be serialized using {{jsxref("JSON.stringify()")}}, which calls the toJSON() method automatically.

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

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

json
{
  "timestamp": 1717509611840,
  "coords": {
    "accuracy": 13.5,
    "latitude": 53.125,
    "longitude": 8.75,
    "altitude": null,
    "altitudeAccuracy": null,
    "heading": null,
    "speed": null
  }
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{jsxref("JSON")}}