Skip to content

Commit 8537a2a

Browse files
mhdawsonmarco-ippolito
authored andcommitted
doc: recommend not using libuv node-api function
- 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 <[email protected]> PR-URL: #53521 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]> Reviewed-By: Gabriel Schulhof <[email protected]> Reviewed-By: Marco Ippolito <[email protected]>
1 parent 61a1c43 commit 8537a2a

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/api/n-api.md

+6
Original file line numberDiff line numberDiff line change
@@ -6229,6 +6229,12 @@ NAPI_EXTERN napi_status napi_get_uv_event_loop(node_api_nogc_env env,
62296229
* `[in] env`: The environment that the API is invoked under.
62306230
* `[out] loop`: The current libuv loop instance.
62316231

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

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

0 commit comments

Comments
 (0)