GeezerVison is showing github.com — node-api: update libuv ABI stability note · nodejs/node@841dfbf
File tree
Expand file treeCollapse file tree
Open diff view settings
Expand file treeCollapse file tree
Open diff view settings
Collapse file
Copy file name to clipboardExpand all lines: doc/api/n-api.md +7-5Lines changed: 7 additions & 5 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -6555,11 +6555,13 @@ NAPI_EXTERN napi_status napi_get_uv_event_loop(node_api_basic_env env, |
6555 | 6555 | * `[in] env`: The environment that the API is invoked under. |
6556 | 6556 | * `[out] loop`: The current libuv loop instance. |
6557 | 6557 |
|
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. |
6563 | 6565 |
|
6564 | 6566 | ## Asynchronous thread-safe function calls |
6565 | 6567 |
|
|