Skip to content

doc: update napi_async_init documentation #33181

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

Closed
mhdawson wants to merge 4 commits into from
Closed

doc: update napi_async_init documentation #33181

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a62c146
doc: update napi_async_init documentation
mhdawson Apr 30, 2020
218f110
Update doc/api/n-api.md
mhdawson May 4, 2020
9d5c4d4
Update doc/api/n-api.md
mhdawson May 4, 2020
ca52b00
Update doc/api/n-api.md
mhdawson May 4, 2020
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
Prev Previous commit
Next Next commit
Update doc/api/n-api.md
  • Loading branch information
@mhdawson
mhdawson authored May 4, 2020
commit 9d5c4d43b1c050176c9d866be4503b7a5de25cc1
5 changes: 5 additions & 0 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4674,6 +4674,11 @@ napi_status napi_async_init(napi_env env,
* `[in] env`: The environment that the API is invoked under.
* `[in] async_resource`: Object associated with the async work
that will be passed to possible `async_hooks` [`init` hooks][].
Comment thread
mhdawson marked this conversation as resolved.
In order to retain ABI compatibility with previous versions,
passing `NULL` for `async_resource` will not result in an error, however,
this will result incorrect operation of async hooks for the
napi_async_context created. Potential issues include
loss of async context when using the AsyncLocalStorage API.
* `[in] async_resource_name`: Identifier for the kind of resource
that is being provided for diagnostic information exposed by the
`async_hooks` API.
Expand Down