Skip to content

doc: recommend not using libuv node-api function #53521

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

Closed
wants to merge 5 commits into from
Closed

doc: recommend not using libuv node-api function #53521

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7520c08
doc: recommend not using libuv node-api function
mhdawson Jun 20, 2024
69234b8
Update doc/api/n-api.md
mhdawson Jun 21, 2024
51bc637
Update doc/api/n-api.md
mhdawson Jun 21, 2024
29e95f6
Update n-api.md
mhdawson Jun 21, 2024
b232a4c
Update doc/api/n-api.md
mhdawson Jun 24, 2024
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
6 changes: 6 additions & 0 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6241,6 +6241,12 @@ NAPI_EXTERN napi_status napi_get_uv_event_loop(node_api_nogc_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.

## Asynchronous thread-safe function calls

JavaScript functions can normally only be called from a native addon's main
Expand Down