Skip to content

Commit 11c388b

Browse files
committed
node-api: update libuv ABI stability note
1 parent 4e612c0 commit 11c388b

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
@@ -6534,11 +6534,13 @@ NAPI_EXTERN napi_status napi_get_uv_event_loop(node_api_basic_env env,
65346534
* `[in] env`: The environment that the API is invoked under.
65356535
* `[out] loop`: The current libuv loop instance.
65366536

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

65436545
## Asynchronous thread-safe function calls
65446546

0 commit comments

Comments
 (0)