Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow jslibbreadcrumb arrow httpxbreadcrumb arrow head(url, [body], [params])
Open source

head(url, [body], [params])

session.head(url, body, params) makes a HEAD request. Only the first parameter is required

ParameterTypeDescription
urlstringHTTP URL. If baseURL is set, provide only path.
body (optional)null / string / object / ArrayBuffer / SharedArrayRequest body; objects will be x-www-form-urlencoded. Set to null to omit the body.
params (optional)null or object {}Additional parameters for this specific request.

Returns

TypeDescription
ResponseHTTP Response object.

Example

JavaScript 
import { Httpx } from 'https://jslib.k6.io/httpx/0.1.0/index.js';

const session = new Httpx({
  baseURL: 'https://httpbin.test.k6.io',
  timeout: 20000, // 20s timeout.
});

export default function testSuite() {
  const resp = session.head(`/head`);
  console.log(resp.status);
}