WorkerGlobalScope: setInterval() method
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
Note: This feature is only available in Web Workers.
The setInterval()
method of the WorkerGlobalScope
interface repeatedly calls a function or executes a code snippet, with a fixed time delay between each call.
This method returns an interval ID which uniquely identifies the interval, so you can remove it later by calling clearInterval()
.
This method is also available in window contexts: for a detailed description of setInterval()
, see the Window.setInterval()
page.
Syntax
setInterval(code)
setInterval(code, delay)
setInterval(func)
setInterval(func, delay)
setInterval(func, delay, arg1)
setInterval(func, delay, arg1, arg2)
setInterval(func, delay, arg1, arg2, /* …, */ argN)
Parameters
func
-
A
function
to be executed everydelay
milliseconds. The first execution happens afterdelay
milliseconds. code
-
An optional syntax allows you to include a string instead of a function, which is compiled and executed every
delay
milliseconds. This syntax is not recommended for the same reasons that make usingeval()
a security risk. delay
Optional-
The time, in milliseconds (thousandths of a second), the timer should delay in between executions of the specified function or code. Defaults to 0 if not specified. See Delay restrictions for details on the permitted range of
delay
values. arg1
, …,argN
Optional-
Additional arguments which are passed through to the function specified by func once the timer expires.
Return value
The returned intervalID
is a numeric, non-zero value which identifies the timer created by the call to setInterval()
; this value can be passed to clearInterval()
to cancel the interval.
It may be helpful to be aware that setInterval()
and setTimeout()
share the same pool of IDs, and that clearInterval()
and clearTimeout()
can technically be used interchangeably.
For clarity, however, you should try to always match them to avoid confusion when maintaining your code.
Note:
The delay
argument is converted to a signed 32-bit integer.
This effectively limits delay
to 2147483647 ms, roughly 24.8 days, since it's specified as a signed integer in the IDL.
Examples
See setInterval()
for examples.
Specifications
Specification |
---|
HTML Standard # dom-setinterval-dev |
Browser compatibility
BCD tables only load in the browser