Skip to content

doc: warn against awaiting replies in module hooks #65590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bitpshr wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Open

doc: warn against awaiting replies in module hooks #65590

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/api/module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1278,6 +1278,12 @@ register('./my-hooks.mjs', {
});
```

A hook can send messages to the thread that registered it at any time, as
above. It must not wait for a reply while it is running: resolution and loading
are synchronous from the perspective of the thread that triggered them, so that
thread is blocked until the hook settles and cannot answer in the meantime.
Awaiting a reply inside a `resolve` or `load` hook deadlocks both threads.

#### Asynchronous hooks accepted by `module.register()`

<!-- YAML
Expand Down
Loading