Skip to content

Commit 841dfbf

Browse files
legendecasaduh95
authored andcommitted
node-api: update libuv ABI stability note
PR-URL: #62789 Reviewed-By: Richard Lau <richard.lau@ibm.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
1 parent 9c700f3 commit 841dfbf

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

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

65646566
## Asynchronous thread-safe function calls
65656567

0 commit comments

Comments
 (0)