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.
Methods #
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.
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.
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.
#[[Symbol.toPrimitive]](): number 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.
#[[Symbol.dispose]](): void Cancels the timeout.
#_onTimeout(...args: any[]): void