createJSONRequest()function

createJSONRequest(method: RequestBodyMethod, url: PossibleURL, body: unknown, options: RequestOptions = {}, caller: AnyCaller = createJSONRequest): Request
ParamType
methodRequestBodyMethod
The HTTP method. required
urlPossibleURL
The target URL. required
bodyunknown
The value to JSON-encode. required
optionsRequestOptions
Additional request options. Defaults to {}
callerAnyCaller
Function to attribute a thrown error to (defaults to createJSONRequest). Defaults to createJSONRequest
Return
Request
A Request with application/json content type.

Create a JSON Request.

  • HEAD and GET requests never send a body.
  • If the JSON body is a data object for HEAD or GET, it is appended as ?query params instead.

Examples

createJSONRequest("POST", "https://api.example.com/items", { name: "abc" })