Immediate

[<Interface>]
type Immediate =
    abstract member _onImmediate (args: obj array) : unit
    abstract member hasRef () : bool
    abstract member ref () : Immediate
    abstract member unref () : Immediate


Assembly	`Xantham.Fable.Node`
Implements	`Disposable`, `RefCounted`

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.

Methods

abstract member _onImmediate (args: obj array) : unit

abstract member hasRef () : bool

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

@since v11.0.0

abstract member ref () : Immediate

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.

@since v9.7.0

Returns. a reference to immediate

abstract member unref () : Immediate

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.

@since v9.7.0

Returns. a reference to immediate