Skip to content

node-api: update libuv ABI stability note #62789

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
legendecas wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −5
Open

node-api: update libuv ABI stability note #62789

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6534,11 +6534,13 @@ NAPI_EXTERN napi_status napi_get_uv_event_loop(node_api_basic_env env,
* `[in] env`: The environment that the API is invoked under.
* `[out] loop`: The current libuv loop instance.

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

[ThreadSafeFunction](#asynchronous-thread-safe-function-calls)
is an ABI-stable alternative for many use cases to calling into the
JavaScript thread from another thread.

## Asynchronous thread-safe function calls

Expand Down
Loading