k6/timers

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 k6/timers
Open source RSS

k6/timers

Implement 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 timing methods are available globally, like in other JavaScript runtimes, and it is unnecessary to import them from the k6/timers module.

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);
}