mirror of
https://github.com/nodejs/node.git
synced 2026-11-09 15:11:11 -05:00
doc: update napi_make_callback documentation
Calling napi_make_callback() with no async_context is not resulting in using the current async context instead an empty context (id 0) is used. Using NULL is like using node::Makecallback without async_context which is deprecated since Node.js 10 (DEP0099). PR-URL: https://github.com/nodejs/node/pull/35321 Fixes: https://github.com/nodejs/node/issues/35188 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
This commit is contained in:
1 parent
109a296e2a
commit
03c4ee91d0
1 file changed
+5
-3
+5
-3
@@ -5180,9 +5180,11 @@ NAPI_EXTERN napi_status napi_make_callback(napi_env env,
|
||||
* `[in] env`: The environment that the API is invoked under.
|
||||
* `[in] async_context`: Context for the async operation that is
|
||||
invoking the callback. This should normally be a value previously
|
||||
obtained from [`napi_async_init`][]. However `NULL` is also allowed,
|
||||
which indicates the current async context (if any) is to be used
|
||||
for the callback.
|
||||
obtained from [`napi_async_init`][].
|
||||
In order to retain ABI compatibility with previous versions, passing `NULL`
|
||||
for `async_context` will not result in an error. However, this will result
|
||||
in incorrect operation of async hooks. Potential issues include loss of
|
||||
async context when using the `AsyncLocalStorage` API.
|
||||
* `[in] recv`: The `this` object passed to the called function.
|
||||
* `[in] func`: `napi_value` representing the JavaScript function to be invoked.
|
||||
* `[in] argc`: The count of elements in the `argv` array.
|
||||
|
||||
Reference in new issue
Block a user