Skip to content

Commit

Permalink
doc: recommend not using libuv node-api function
Browse files Browse the repository at this point in the history
- update documentation recommend not using the
  napi_get_uv_event_loop  function. It should not be
  need for most if not all uses cases now that the
  API is more complete.

Signed-off-by: Michael Dawson <midawson@redhat.com>
PR-URL: #53521
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
  • Loading branch information
mhdawson authored and marco-ippolito committed Jul 19, 2024
1 parent 61a1c43 commit 8537a2a
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6229,6 +6229,12 @@ NAPI_EXTERN napi_status napi_get_uv_event_loop(node_api_nogc_env env,
* `[in] env`: The environment that the API is invoked under.
* `[out] loop`: The current libuv loop instance.

Note: While libuv has been relatively stable over time, it does
not provide an ABI stability guarantee. Use of this function should be avoided.
Its use may result in an addon that does not work across Node.js versions.
[asynchronous-thread-safe-function-calls](https://nodejs.org/docs/latest/api/n-api.html#asynchronous-thread-safe-function-calls)
are an alternative for many use cases.

## Asynchronous thread-safe function calls

JavaScript functions can normally only be called from a native addon's main
Expand Down

0 comments on commit 8537a2a

Please sign in to comment.