summaryrefslogtreecommitdiff
path: root/doc/api/async_hooks.md
diff options
context:
space:
mode:
authorHarshitha KP <harshi46@in.ibm.com>2020-02-19 05:27:52 -0500
committerAnna Henningsen <anna@addaleax.net>2020-03-11 17:01:08 +0100
commite4a72d6b60008385812a819906b13daeffae76ad (patch)
treedfb679c2e221524cd2601a1ed2725b9795637f88 /doc/api/async_hooks.md
parent7baadb30bb49afe25a509620696004ac657c304f (diff)
downloadnode-new-e4a72d6b60008385812a819906b13daeffae76ad.tar.gz
doc: add entry for `AsyncHook` class
fixes: https://github.com/nodejs/node/issues/31661 PR-URL: https://github.com/nodejs/node/pull/31865 Fixes: https://github.com/nodejs/node/issues/31661 Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/async_hooks.md')
-rw-r--r--doc/api/async_hooks.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md
index f02d3ff755..fd5075c625 100644
--- a/doc/api/async_hooks.md
+++ b/doc/api/async_hooks.md
@@ -170,6 +170,11 @@ provided by AsyncHooks itself. The logging should then be skipped when
it was the logging itself that caused AsyncHooks callback to call. By
doing this the otherwise infinite recursion is broken.
+### Class: `AsyncHook`
+
+The class `AsyncHook` exposes an interface for tracking lifetime events
+of asynchronous operations.
+
#### `asyncHook.enable()`
* Returns: {AsyncHook} A reference to `asyncHook`.