diff --git a/doc/api/addons.md b/doc/api/addons.md index 9ccf07f777a5ba..e2df5f30e9a32a 100644 --- a/doc/api/addons.md +++ b/doc/api/addons.md @@ -221,7 +221,7 @@ illustration of how it can be used. > Stability: 1 - Experimental N-API is an API for building native Addons. It is independent from -the underlying JavaScript runtime (ex V8) and is maintained as part of +the underlying JavaScript runtime (e.g., V8) and is maintained as part of Node.js itself. This API will be Application Binary Interface (ABI) stable across version of Node.js. It is intended to insulate Addons from changes in the underlying JavaScript engine and allow modules @@ -232,6 +232,41 @@ set of APIs that are used by the native code. Instead of using the V8 or [Native Abstractions for Node.js][] APIs, the functions available in the N-API are used. +To use N-API in the above "Hello world" example, replace the content of +`hello.cc` with the following. All other instructions remain the same. + +```cpp +// hello.cc using N-API +#include + +namespace demo { + +napi_value Method(napi_env env, napi_callback_info args) { + napi_value greeting; + napi_status status; + + status = napi_create_string_utf8(env, "hello", 6, &greeting); + if (status != napi_ok) return nullptr; + return greeting; +} + +napi_value init(napi_env env, napi_value exports) { + napi_status status; + napi_value fn; + + status = napi_create_function(env, nullptr, 0, Method, nullptr, &fn); + if (status != napi_ok) return nullptr; + + status = napi_set_named_property(env, exports, "hello", fn); + if (status != napi_ok) return nullptr; + return exports; +} + +NAPI_MODULE(NODE_GYP_MODULE_NAME, init) + +} // namespace demo +``` + The functions available and how to use them are documented in the section titled [C/C++ Addons - N-API](n-api.html).