createHeadRequest()function

createHeadRequest(method: RequestHeadMethod, url: PossibleURL, params: Nullish<PossibleURIParams>, options: RequestOptions = {}, caller: AnyCaller = createHeadRequest): Request
ParamType
methodRequestHeadMethod
The HTTP method. required
urlPossibleURL
The target URL. required
paramsNullish<PossibleURIParams>
?query params to encode into the URL. required
optionsRequestOptions
Additional request options. Defaults to {}
callerAnyCaller
Function to attribute a thrown error to (defaults to createHeadRequest). Defaults to createHeadRequest
Return
Request
A Request with no body content.

Create a body-less Request.

  • HEAD and GET requests never send a body.

Examples

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