Skip to content
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

Jump to bottom

n-api: add napi_get_version #13207

Closed
wants to merge 4 commits into from
Closed

n-api: add napi_get_version #13207

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a1c224c
n-api: add napi_get_version
mhdawson May 24, 2017
fbee2f5
squash: address comments
mhdawson May 25, 2017
86cc570
squash: address comments
mhdawson May 25, 2017
fcb9f8b
squash: address comments
mhdawson May 26, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 11 additions & 10 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2964,16 +2964,17 @@ Returns `napi_ok` if the API succeeded.

This API returns the highest N-API version supported by the
Node.js runtime. N-API is planned to be additive such that
newer releases of Node.js may support additional API functions. Since
the goal is forward compatibility, older versions may not support
the new functions even if we port empty stubs to earlier Node.js
versions in order to facilitate use of the new functions with later
Node.js releases. To support this case an addon can call
`napi_get_version` to check which level of N-API is supported
at run time. Based on the result of this check the addon can
implement appropriate code paths when functions
are, or are not, fully implemented.

newer releases of Node.js may support additional API functions.
In order to allow an addon to use a newer function when running with
versions of Node.js that support it, while providing
fallback behaviour when runnign with Node.js versions that don't
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: runnign

Also, do we prefer American or British spelling of "behaviour"?

support it:

* Call `napi_get_version()` to determine if the API is available.
* If available, dynamically load a pointer to the function using `uv_dlsym()`.
* Use the dynamically loaded pointer to invoke the function.
* If the function is not available, provide an alternate implementation
that does not use the function.

[Aynchronous Operations]: #n_api_asynchronous_operations
[Basic N-API Data Types]: #n_api_basic_n_api_data_types
Expand Down