Commit 8537a2a
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 <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>1 parent 61a1c43 commit 8537a2a
1 file changed
Lines changed: 6 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -6229,6 +6229,12 @@ NAPI_EXTERN napi_status napi_get_uv_event_loop(node_api_nogc_env env, | |||
| 6229 | 6229 | * `[in] env`: The environment that the API is invoked under. | |
| 6230 | 6230 | * `[out] loop`: The current libuv loop instance. | |
| 6231 | 6231 | ||
| 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 | + | ||
| 6232 | 6238 | ## Asynchronous thread-safe function calls | |
| 6233 | 6239 | ||
| 6234 | 6240 | JavaScript functions can normally only be called from a native addon's main | |
0 commit comments