ApplesauceOS
Read Markdown ↗Download .md

request.head

Send an HTTP HEAD request.

js
request.head(input, options?, callback)

Arguments

ArgumentTypeMeaning
inputstring | objectURL string or options object.
optionsobjectOptional url/uri, method, headers, string body, json, form, qs and timeout (milliseconds).
callbackfunction(error, response, body). Response has statusCode, lowercase headers, body and url.

Returns

Request handle with abort().

Example

js
const request = require("request");
request.head("https://example.com", {timeout: 5000}, (error, response) => {
  if (error) throw error;
  console.log(response.statusCode);
});

Notes

Use your own endpoint. HTTP error status is a response, not a transport error.

All JavaScript APIs · Automation playbook