Skip to main content

function setTimeout

Overload 1

#setTimeout<TArgs extends any[]>(
callback: (...args: TArgs) => void,
delay?: number,
...args: TArgs,
): Timeout

Schedules execution of a one-time callback after delay milliseconds.

The callback will likely not be invoked in precisely delay milliseconds. Node.js makes no guarantees about the exact timing of when callbacks will fire, nor of their ordering. The callback will be called as close as possible to the time specified.

When delay is larger than 2147483647 or less than 1 or NaN, the delay will be set to 1. Non-integer delays are truncated to an integer.

If callback is not a function, a TypeError will be thrown.

This method has a custom variant for promises that is available using timersPromises.setTimeout().

Type Parameters #

#TArgs extends any[]

Parameters #

#callback: (...args: TArgs) => void

The function to call when the timer elapses.

#delay: number
optional

The number of milliseconds to wait before calling the callback. Default: 1.

#...args: TArgs

Return Type #

Timeout

for use with clearTimeout()

Overload 2

#setTimeout(
callback: (_: void) => void,
delay?: number,
): Timeout

Parameters #

#callback: (_: void) => void
#delay: number
optional

Return Type #

Timeout