Class TapWrap

Wrapper for the async-hook-domain that catches errors thrown during test operation.

See

https://npmjs.com/async-hook-domain

Hierarchy

  • AsyncResource
    • TapWrap

Constructors

constructor

Properties

onDestroy? test

Methods

asyncId bind emitDestroy runInAsyncScope triggerAsyncId bind

Constructors

constructor

Properties

OptionalonDestroy

onDestroy?: (() => void)

test

test: Base<TapBaseEvents>

Methods

asyncId

  • asyncId(): number

  • Returns number

    The unique asyncId assigned to the resource.

bind

  • bind<Func>(fn): Func

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

    Type Parameters

    • Func extends ((...args: any[]) => any)

    Parameters

    • fn: Func

      The function to bind to the current AsyncResource.

    Returns Func

    Since

    v14.8.0, v12.19.0

emitDestroy

  • emitDestroy(): TapWrap

  • Call all destroy hooks. This should only ever be called once. An error will be thrown if it is called more than once. This must be manually called. If the resource is left to be collected by the GC then the destroy hooks will never be called.

    Returns TapWrap

    A reference to asyncResource.

runInAsyncScope

  • runInAsyncScope<This, Result>(fn, thisArg?, ...args): 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.

    Type Parameters

    • This
    • Result

    Parameters

    • fn: ((this: This, ...args: any[]) => Result)

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

    • OptionalthisArg: This

      The receiver to be used for the function call.

    • Rest...args: any[]

      Optional arguments to pass to the function.

    Returns Result

    Since

    v9.6.0

triggerAsyncId

  • triggerAsyncId(): number

  • Returns number

    The same triggerAsyncId that is passed to the AsyncResource constructor.

Staticbind

  • bind<Func, ThisArg>(fn, type?, thisArg?): Func

  • Binds the given function to the current execution context.

    Type Parameters

    • Func extends ((this: ThisArg, ...args: any[]) => any)
    • ThisArg

    Parameters

    • fn: Func

      The function to bind to the current execution context.

    • Optionaltype: string

      An optional name to associate with the underlying AsyncResource.

    • OptionalthisArg: ThisArg

    Returns Func

    Since

    v14.8.0, v12.19.0

Settings

Member Visibility

On This Page

Constructors
Properties
Methods