This is documentation for the next version of Grafana k6 documentation. For the latest stable release, go to the latest version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/timers
Open source

k6/timers

The k6/timers module implements timers to work with k6’s event loop. They mimic the functionality found in browsers and other JavaScript runtimes.

FunctionDescription
setTimeoutSets a function to be run after a given timeout.
clearTimeoutClears a previously set timeout with setTimeout.
setIntervalSets a function to be run on a given interval.
clearIntervalClears a previously set interval with setInterval.

Note

The timer methods are available globally, so you can use them in your script without including an import statement.

Example

JavaScript 
export default function () {
  const intervalId = setInterval(() => {
    console.log('This runs every 200ms');
  }, 200);

  const timeoutId = setTimeout(() => {
    console.log('This runs after 2s');

    // clear the timeout and interval to exit k6
    clearInterval(intervalId);
    clearTimeout(timeoutId);
  }, 2000);
}