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.

Documentation

setGeolocation(geolocation)

Open source

setGeolocation(geolocation)

Caution
This feature has known issues. For details, refer to #435.

Sets the browser context’s geolocation.

Parameter	Type	Default	Description
geolocation	object	`null`
geolocation.latitude	number	`0`	Latitude between -90 and 90.
geolocation.longitude	number	`0`	Latitude between -180 and 180.
geolocation.accuracy	number	`0`	Optional non-negative accuracy value.

Returns

Type	Description
`Promise<void>`	A Promise that fulfills when the geolocation has been set.

Example

import { browser } from 'k6/browser';

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

export default async function () {
  const context = await browser.newContext();
  await context.setGeolocation({ latitude: 59.95, longitude: 30.31667 });
}