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

Jump to bottom

doc: update napi_async_init documentation #33181

Closed
wants to merge 4 commits into from
Closed

doc: update napi_async_init documentation #33181

Changes from 3 commits
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
13 changes: 12 additions & 1 deletion doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4672,15 +4672,26 @@ napi_status napi_async_init(napi_env env,
```

* `[in] env`: The environment that the API is invoked under.
* `[in] async_resource`: An optional object associated with the async work
* `[in] async_resource`: Object associated with the async work
that will be passed to possible `async_hooks` [`init` hooks][].
mhdawson marked this conversation as resolved.
Show resolved Hide 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.
* `[out] result`: The initialized async context.

Returns `napi_ok` if the API succeeded.

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.

mhdawson marked this conversation as resolved.
Show resolved Hide resolved
### napi_async_destroy
<!-- YAML
added: v8.6.0
Expand Down