Request: json() method

{{APIRef("Fetch API")}}{{AvailableInWorkers}}

The json() method of the {{domxref("Request")}} interface reads the request body and returns it as a promise that resolves with the result of parsing the body text as {{JSxRef("JSON")}}.

Note that despite the method being named json(), the result is not JSON but is instead the result of taking JSON as input and parsing it to produce a JavaScript object.

Syntax

json()

Parameters

None.

Return value

A {{jsxref("Promise")}} that resolves to a JavaScript object. This object could be anything that can be represented by JSON — an object, an array, a string, a number…

Exceptions

• {{jsxref("TypeError")}}
  • : Thrown for one of the following reasons:
    • The request body is disturbed or locked.
    • There was an error decoding the body content (for example, because the {{httpheader("Content-Encoding")}} header is incorrect).
• {{jsxref("SyntaxError")}}
  • : The request body cannot be parsed as JSON.

Examples

const obj = { hello: "world" };

const request = new Request("/myEndpoint", {
  method: "POST",
  body: JSON.stringify(obj),
});

request.json().then((data) => {
  // do something with the data sent in the request
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{domxref("Response.json()")}}