setTimeout - timers - Node

setTimeout - timers - Node documentation

function setTimeout

Usage in Deno

import { setTimeout } from "node:timers";



setTimeout<TArgs extends any[]>(callback: (...args: TArgs) => void,
ms?: 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, 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.

optional



ms: number



...args: TArgs

Return Type

Timeout

for use with clearTimeout



setTimeout(callback: (args: void) => void,
ms?: number,
): Timeout

Parameters



callback: (args: void) => void

optional



ms: number

Return Type

Timeout

namespace setTimeout

Variables

setTimeout.__promisify__

No documentation available

variable setTimeout

Type

global.setTimeout