Join us online - 19th of November
Save your spot

Interface Timeout

This object is created internally and is returned from setTimeout() and setInterval(). It can be passed to either clearTimeout() or clearInterval() in order to cancel the scheduled actions.

By default, when a timer is scheduled using either setTimeout() or setInterval(), the Node.js event loop will continue running as long as the timer is active. Each of the Timeout objects returned by these functions export both timeout.ref() and timeout.unref() functions that can be used to control this default behavior.

interface Timeout {
    _onTimeout(...args: any[]): void;
    "[dispose]"(): void;
    "[toPrimitive]"(): number;
    close(): this;
    hasRef(): boolean;
    ref(): this;
    refresh(): this;
    unref(): this;
}

Hierarchy (View Summary)

Index
_onTimeout [dispose] [toPrimitive] close hasRef ref refresh unref

_onTimeout

  • _onTimeout(...args: any[]): void

    Parameters

    • ...args: any[]

    Returns void

  • Cancels the timeout.

    Returns void

    v20.5.0, v18.18.0

  • Coerce a Timeout to a primitive. The primitive can be used to clear the Timeout. The primitive can only be used in the same thread where the timeout was created. Therefore, to use it across worker_threads it must first be passed to the correct thread. This allows enhanced compatibility with browser setTimeout() and setInterval() implementations.

    Returns number

    v14.9.0, v12.19.0

  • Cancels the timeout.

    Returns this

    a reference to timeout

    v0.9.1

    Use clearTimeout() instead.

  • If true, the Timeout object will keep the Node.js event loop active.

    Returns boolean

    v11.0.0

  • When called, requests that the Node.js event loop not exit so long as the Timeout is active. Calling timeout.ref() multiple times will have no effect.

    By default, all Timeout objects are "ref'ed", making it normally unnecessary to call timeout.ref() unless timeout.unref() had been called previously.

    Returns this

    a reference to timeout

    v0.9.1

  • Sets the timer's start time to the current time, and reschedules the timer to call its callback at the previously specified duration adjusted to the current time. This is useful for refreshing a timer without allocating a new JavaScript object.

    Using this on a timer that has already called its callback will reactivate the timer.

    Returns this

    a reference to timeout

    v10.2.0

  • When called, the active Timeout object will not require the Node.js event loop to remain active. If there is no other activity keeping the event loop running, the process may exit before the Timeout object's callback is invoked. Calling timeout.unref() multiple times will have no effect.

    Returns this

    a reference to timeout

    v0.9.1

Was this helpful?