Index - Node documentation

Usage

import * as mod from "node:async_hooks";

We strongly discourage the use of the async_hooks API. Other APIs that can cover most of its use cases include:

  • AsyncLocalStorage tracks async context
  • process.getActiveResourcesInfo() tracks active resources

The node:async_hooks module provides an API to track asynchronous resources. It can be accessed using:

import async_hooks from 'node:async_hooks';

Classes

c
AsyncLocalStorage

This class creates stores that stay coherent through asynchronous operations.

c
AsyncResource

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

Functions

f
createHook

Registers functions to be called for different lifetime events of each async operation.

f
executionAsyncId
No documentation available
f
executionAsyncResource

Resource objects returned by executionAsyncResource() are most often internal Node.js handle objects with undocumented APIs. Using any functions or properties on the object is likely to crash your application and should be avoided.

f
triggerAsyncId
No documentation available

Interfaces

I
AsyncHook
No documentation available
I
AsyncResourceOptions
No documentation available
I
HookCallbacks
No documentation available