timers/promises

• const scheduler: Scheduler
• function setImmediate<T = void>(

  value?: T,

  options?: TimerOptions

  ): Promise<T>;

  import {
    setImmediate,
  } from 'node:timers/promises';
  
  const res = await setImmediate('result');
  
  console.log(res);  // Prints 'result'
  

  @param value

  A value with which the promise is fulfilled.

• function setInterval<T = void>(

  delay?: number,

  value?: T,

  options?: TimerOptions

  ): AsyncIterator<T>;

  Returns an async iterator that generates values in an interval of delay ms. If ref is true, you need to call next() of async iterator explicitly or implicitly to keep the event loop alive.

  import {
    setInterval,
  } from 'node:timers/promises';
  
  const interval = 100;
  for await (const startTime of setInterval(interval, Date.now())) {
    const now = Date.now();
    console.log(now);
    if ((now - startTime) > 1000)
      break;
  }
  console.log(Date.now());
  

  @param delay

  The number of milliseconds to wait between iterations. Default: 1.

  @param value

  A value with which the iterator returns.

• function setTimeout<T = void>(

  delay?: number,

  value?: T,

  options?: TimerOptions

  ): Promise<T>;

  import {
    setTimeout,
  } from 'node:timers/promises';
  
  const res = await setTimeout(100, 'result');
  
  console.log(res);  // Prints 'result'
  

  @param delay

  The number of milliseconds to wait before fulfilling the promise. Default: 1.

  @param value

  A value with which the promise is fulfilled.

Type definitions

• interface Scheduler

  • wait(

    delay: number,

    options?: { signal: AbortSignal }

    ): Promise<void>;

    An experimental API defined by the Scheduling APIs draft specification being developed as a standard Web Platform API.

    Calling timersPromises.scheduler.wait(delay, options) is roughly equivalent to calling timersPromises.setTimeout(delay, undefined, options) except that the ref option is not supported.

    import { scheduler } from 'node:timers/promises';
    
    await scheduler.wait(1000); // Wait one second before continuing
    

    @param delay

    The number of milliseconds to wait before resolving the promise.

  • yield(): Promise<void>;

    An experimental API defined by the Scheduling APIs draft specification being developed as a standard Web Platform API.

    Calling timersPromises.scheduler.yield() is equivalent to calling timersPromises.setImmediate() with no arguments.