headerValue(name)

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.

Open source

headerValue(name)

Returns the value of the header matching the name. The name is case insensitive.

ParameterTypeDescription
namestringHeader name to retrieve values for.

Returns

TypeDescription
Promise<string | null>A promise that resolves to the value of the header matching the name, otherwise null.

Example

JavaScript
import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    const res = await page.goto('https://test.k6.io/');

    const headerValue = await res.headerValue('connection');
    console.log(`headerValue: ${headerValue}`); // headerValue: keep-alive
  } finally {
    await page.close();
  }
}