Skip to content
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

doc: add note about resource type in async_hooks #41797

Merged
merged 5 commits into from
Feb 3, 2022
Merged

doc: add note about resource type in async_hooks #41797

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
385ddae
doc: add note about resource type in async_hooks
tony-go Jan 31, 2022
e1aff5c
doc: lint file
tony-go Jan 31, 2022
bac310c
doc: fix note about resource type
tony-go Feb 1, 2022
b2622ce
doc: delete useless note makrer
tony-go Feb 2, 2022
95e1349
doc: add note details
tony-go Feb 2, 2022
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
5 changes: 5 additions & 0 deletions doc/api/async_hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,8 @@ The `type` is a string identifying the type of resource that caused
`init` to be called. Generally, it will correspond to the name of the
resource's constructor.

Here is a list of potential _identifiers_:
Flarna marked this conversation as resolved.
Show resolved Hide resolved

```text
FSEVENTWRAP, FSREQCALLBACK, GETADDRINFOREQWRAP, GETNAMEINFOREQWRAP, HTTPINCOMINGMESSAGE,
HTTPCLIENTREQUEST, JSSTREAM, PIPECONNECTWRAP, PIPEWRAP, PROCESSWRAP, QUERYWRAP,
Expand All @@ -337,6 +339,9 @@ TTYWRAP, UDPSENDWRAP, UDPWRAP, WRITEWRAP, ZLIB, SSLCONNECTION, PBKDF2REQUEST,
RANDOMBYTESREQUEST, TLSWRAP, Microtask, Timeout, Immediate, TickObject
```

**Note**: you should not rely too much on these _identifiers_
as they could arbitrarily change.
Flarna marked this conversation as resolved.
Show resolved Hide resolved

There is also the `PROMISE` resource type, which is used to track `Promise`
instances and asynchronous work scheduled by them.

Expand Down