AsyncResource

@JSImport("async_hooks", "AsyncResource") @native @JSType class AsyncResource extends StObject

The class AsyncResource was designed to be extended by the embedder's async resources. Using this users can easily trigger the lifetime events of their own resources.

Companion
object
trait StObject
class Object
trait Any
class Object
trait Matchable
class Any

Value members

Constructors

def this(`type`: String)

AsyncResource() is meant to be extended. Instantiating a new AsyncResource() also triggers init. If triggerAsyncId is omitted then async_hook.executionAsyncId() is used.

AsyncResource() is meant to be extended. Instantiating a new AsyncResource() also triggers init. If triggerAsyncId is omitted then async_hook.executionAsyncId() is used.

Value Params
triggerAsyncId

The ID of the execution context that created this async event (default: executionAsyncId()), or an AsyncResourceOptions object (since 9.3)

type

The type of async event.

def this(`type`: String, triggerAsyncId: AsyncResourceOptions)
def this(`type`: String, triggerAsyncId: Double)

Concrete methods

def asyncId(): Double
Returns

the unique ID assigned to this AsyncResource instance.

def bind[Func](fn: Func): Func & AsyncResource

Binds the given function to execute to this AsyncResource's scope.

Binds the given function to execute to this AsyncResource's scope.

Value Params
fn

The function to bind to the current AsyncResource.

Call AsyncHooks destroy callbacks.

Call AsyncHooks destroy callbacks.

def runInAsyncScope[This, Result](fn: ThisFunction1[This, Any, Result], thisArg: This, args: Any*): Result

Call the provided function with the provided arguments in the execution context of the async resource. This will establish the context, trigger the AsyncHooks before callbacks, call the function, trigger the AsyncHooks after callbacks, and then restore the original execution context.

Call the provided function with the provided arguments in the execution context of the async resource. This will establish the context, trigger the AsyncHooks before callbacks, call the function, trigger the AsyncHooks after callbacks, and then restore the original execution context.

Value Params
args

Optional arguments to pass to the function.

fn

The function to call in the execution context of this async resource.

thisArg

The receiver to be used for the function call.

def runInAsyncScope[This, Result](fn: ThisFunction1[This, Any, Result], thisArg: Unit, args: Any*): Result
def triggerAsyncId(): Double
Returns

the trigger ID for this AsyncResource instance.

Inherited methods

def hasOwnProperty(v: String): Boolean
Inherited from
Object
def isPrototypeOf(v: Object): Boolean
Inherited from
Object
def propertyIsEnumerable(v: String): Boolean
Inherited from
Object
def toLocaleString(): String
Inherited from
Object
def valueOf(): Any
Inherited from
Object