Skip to content

Commit 952c9e8

Browse files
authored
node-api: update libuv ABI stability note
PR-URL: #62789 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Santiago Gimeno <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
1 parent 5e0bcab commit 952c9e8

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

doc/api/n-api.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6569,11 +6569,13 @@ NAPI_EXTERN napi_status napi_get_uv_event_loop(node_api_basic_env env,
65696569
* `[in] env`: The environment that the API is invoked under.
65706570
* `[out] loop`: The current libuv loop instance.
65716571

6572-
Note: While libuv has been relatively stable over time, it does
6573-
not provide an ABI stability guarantee. Use of this function should be avoided.
6574-
Its use may result in an addon that does not work across Node.js versions.
6575-
[asynchronous-thread-safe-function-calls](https://nodejs.org/docs/latest/api/n-api.html#asynchronous-thread-safe-function-calls)
6576-
are an alternative for many use cases.
6572+
Note: While libuv only [guarantees ABI stability](https://github.com/libuv/libuv?tab=readme-ov-file#versioning)
6573+
in a major version, its use may result in an addon that does not work across
6574+
Node.js major versions.
6575+
6576+
[ThreadSafeFunction](#asynchronous-thread-safe-function-calls)
6577+
is an ABI-stable alternative for many use cases to calling into the
6578+
JavaScript thread from another thread.
65776579

65786580
## Asynchronous thread-safe function calls
65796581

0 commit comments

Comments
 (0)