createXMLRequest()function

createXMLRequest(method: RequestBodyMethod, url: PossibleURL, data: Data, options: RequestOptions = {}, caller: AnyCaller = createXMLRequest): Request
ParamType
methodRequestBodyMethod
The HTTP method. required
urlPossibleURL
The target URL. required
dataData
The data object to serialize as XML. required
optionsRequestOptions
Additional request options. Defaults to {}
callerAnyCaller
Function to attribute a thrown error to (defaults to createXMLRequest). Defaults to createXMLRequest
Return
Request
A Request with application/xml content type.
Throws
RequiredError
If the XML data contains invalid element names or values.

Create an XML Request.

  • HEAD and GET requests never send a body.
  • For HEAD and GET, the data object is appended as ?query params instead.

Examples

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