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

Index

Constructors

Properties

onDestroy? test

Methods

asyncId bind emitDestroy runInAsyncScope triggerAsyncId bind

Constructors

constructor

new TapWrap(test: Base): TapWrap
Parameters
- test: Base
Returns TapWrap
Overrides AsyncResource.constructor
- Defined in src/core/src/base.ts:50

Properties

`Optional`onDestroy

onDestroy?: () => void

test

test: Base

Methods

asyncId

asyncId(): number
Returns number
The unique asyncId assigned to the resource.
Inherited from AsyncResource.asyncId
- Defined in node_modules/@types/node/async_hooks.d.ts:317

bind

bind<Func extends (...args: any[]) => any>(fn: Func): 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
Inherited from AsyncResource.bind
- Defined in node_modules/@types/node/async_hooks.d.ts:290

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.
Overrides AsyncResource.emitDestroy
- Defined in src/core/src/base.ts:54

runInAsyncScope

runInAsyncScope<This, Result>(
    fn: (this: This, ...args: 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.
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.
- ...args: any[]
  Optional arguments to pass to the function.
Returns Result
Since
v9.6.0
Inherited from AsyncResource.runInAsyncScope
- Defined in node_modules/@types/node/async_hooks.d.ts:301

triggerAsyncId

triggerAsyncId(): number
Returns number
The same triggerAsyncId that is passed to the AsyncResource constructor.
Inherited from AsyncResource.triggerAsyncId
- Defined in node_modules/@types/node/async_hooks.d.ts:321

`Static`bind

bind<Func extends (this: ThisArg, ...args: any[]) => any, ThisArg>(
    fn: Func,
    type?: string,
    thisArg?: 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
Inherited from AsyncResource.bind
- Defined in node_modules/@types/node/async_hooks.d.ts:280