Commit cf88ed8
doc: update napi_async_init documentation
Fixes: #33153
Change documentation to make async_resource required
as opposed to optional in napi-async_init.
Changes over time mean this parameter is required for
proper operation of async hooks (which are still experimental).
This changes the documentation to document what
callers should do. We are doing this only in the doc
in order to avoid a breaking change in N-API. We could
create a new version of the method for which the
parametrer is enforced as mandatory but we should only
do that once async hooks is no longer experimental. In
that case we could deprecate (but not remove this version
of the method).
Signed-off-by: Michael Dawson <michael_dawson@ca.ibm.com>
PR-URL: #33181
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>1 parent 25443fa commit cf88ed8
1 file changed
Lines changed: 6 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -4672,8 +4672,13 @@ napi_status napi_async_init(napi_env env, | |||
| 4672 | 4672 | ``` | |
| 4673 | 4673 | ||
| 4674 | 4674 | * `[in] env`: The environment that the API is invoked under. | |
| 4675 | - * `[in] async_resource`: An optional object associated with the async work | ||
| 4675 | + * `[in] async_resource`: Object associated with the async work | ||
| 4676 | 4676 | that will be passed to possible `async_hooks` [`init` hooks][]. | |
| 4677 | + In order to retain ABI compatibility with previous versions, | ||
| 4678 | + passing `NULL` for `async_resource` will not result in an error, however, | ||
| 4679 | + this will result incorrect operation of async hooks for the | ||
| 4680 | + napi_async_context created. Potential issues include | ||
| 4681 | + loss of async context when using the AsyncLocalStorage API. | ||
| 4677 | 4682 | * `[in] async_resource_name`: Identifier for the kind of resource | |
| 4678 | 4683 | that is being provided for diagnostic information exposed by the | |
| 4679 | 4684 | `async_hooks` API. | |
0 commit comments