Class Immediate

This object is created internally and is returned from setImmediate(). It can be passed to clearImmediate() in order to cancel the scheduled actions.

By default, when an immediate is scheduled, the Node.js event loop will continue running as long as the immediate is active. The Immediate object returned by setImmediate() exports both immediate.ref() and immediate.unref() functions that can be used to control this default behavior.

Implements

Constructors

constructor

Properties

_onImmediate

Methods

[dispose] hasRef ref unref

Constructors

constructor

Properties

_onImmediate

_onImmediate: Function

Methods

[dispose]

  • [dispose](): void

  • Cancels the immediate. This is similar to calling clearImmediate().

    Returns void

    Since

    v20.5.0

hasRef

  • hasRef(): boolean

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

    Returns boolean

    Since

    v11.0.0

ref

  • ref(): this

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

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

    Returns this

    a reference to immediate

    Since

    v9.7.0

unref

  • unref(): this

  • When called, the active Immediate 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 Immediate object's callback is invoked. Calling immediate.unref() multiple times will have no effect.

    Returns this

    a reference to immediate

    Since

    v9.7.0

On This Page