doc: clarify that async_hook callbacks cannot be async · nodejs/node@4785755 · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 633
• Pull requests 755
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 4785755

Browse filesBrowse the repository at this point in the historyBrowse files

jasnell

authored and

targos

committed

doc: clarify that async_hook callbacks cannot be async

Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: #37384 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>

1 parent 512ae7e commit 4785755
Copy full SHA for 4785755

1 file changed

+4Lines changed: 4 additions & 0 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • async_hooks.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/async_hooks.md‎

Copy file name to clipboardExpand all lines: doc/api/async_hooks.md

+4Lines changed: 4 additions & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -129,6 +129,10 @@ class MyAddedCallbacks extends MyAsyncCallbacks {
129	129	const asyncHook = async_hooks.createHook(new MyAddedCallbacks());
130	130	```
131	131
	132	+ Because promises are asynchronous resources whose lifecycle is tracked
	133	+ via the async hooks mechanism, the `init()`, `before()`, `after()`, and
	134	+ `destroy()` callbacks *must not* be async functions that return promises.
	135	+
132	136	##### Error handling
133	137
134	138	If any `AsyncHook` callbacks throw, the application will print the stack trace

0 commit comments

Comments

0 (0)