-
Notifications
You must be signed in to change notification settings - Fork 34
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.
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
Clarify C++ wrapping documentation #308
Comments
I agree, that the documentation, in general, is somewhat confusing as it appears to address the C API. My impression is that |
People can choose to use the C or C++ versions based on their preference. The C version is the abi stable API. the C++ node-addon-api (with napi.h) is sugar to make consuming the C version easier for those using C++. We are currently working on the C++ napi.h documentation in the node-addon-api repo, with the README.md currently being the index. https://github.com/nodejs/node-addon-api. It is still incomplete in many places though, but we are working on it. |
We've made a long of improvements since this was opened both in the node-addon-api docs as well as the in the core Node.js docs. I think this can now be close. Closing, please let us know if you think that was not the right thing to do. |
Perhaps our
napi_wrap()/napi_unwrap()/napi_remove_wrap()
documentation is too C++-specific. We should certainly draw the parallel to C++ instances, but we should not phrase the documentation as though that's the only use case.The text was updated successfully, but these errors were encountered: