![Examples – C- API
#include <node_api.h>
napi_value RunCallback(napi_env env, const napi_callback_info info) {
napi_status status;
size_t argc = 1;
napi_value args[1];
status = napi_get_cb_info(env, info, &argc, args, nullptr, nullptr);
napi_value cb = args[0];
napi_value argv[1];
status = napi_create_string_utf8(env, "hello world", NAPI_AUTO_LENGTH, argv);
napi_value global;
status = napi_get_global(env, &global);
napi_value result;
status = napi_call_function(env, global, cb, 1, argv, &result);
return nullptr;
}
optional 'this'
optional 'data pointer'
optional length
NODE_BUILD=/home/mhdawson/newpull/io.js
export PATH=$NODE_BUILD:$NODE_BUILD/../abi-stable-node-addon-
examples/node_modules/node-gyp/bin/:$PATH
export NPM=$NODE_BUILD/deps/npm/bin/npm-cli.js
alias npm=$NPM
alias node-gyp=node-gyp.js
export npm_config_nodedir=$NODE_BUILD](https://image.slidesharecdn.com/n-api-nodeinteractive-171011205206/85/N-api-node-interactive-2017-14-320.jpg)
![Example – C++ Wrapper Example
NaN node-addon-api
void Init(v8::Local<v8::Object> exports,
v8::Local<v8::Object> module) {
Nan::SetMethod(module, "exports", RunCallback);
}
void RunCallback(const Napi::CallbackInfo& info) {
Napi::Env env = info.Env();
Napi::Function cb = info[0].As<Napi::Function>();
cb.MakeCallback(env.Global(), {
Napi::String::New(env, "hello world")
});
}
https://github.com/nodejs/abi-stable-node-addon-examples/tree/master/3_callbacks/node-addon-api
https://github.com/nodejs/node-addon-api/blob/master/tools/conversion.js
#include <nan.h>
void RunCallback(const Nan::FunctionCallbackInfo<v8::Value>& info) {
v8::Local<v8::Function> cb = info[0].As<v8::Function>();
const unsigned argc = 1;
v8::Local<v8::Value> argv[argc] =
{ Nan::New("hello world").ToLocalChecked() };
Nan::MakeCallback(Nan::GetCurrentContext()->Global(), cb, argc, argv);
}
NODE_MODULE(addon, Init)
#include <napi.h>
Napi::Object Init(Napi::Env env, Napi::Object exports) {
return Napi::Function::New(env, RunCallback);
}
NODE_API_MODULE(addon, Init)](https://image.slidesharecdn.com/n-api-nodeinteractive-171011205206/85/N-api-node-interactive-2017-16-320.jpg)
![[DEPRECATED]Gradle the android](https://cdn.slidesharecdn.com/ss_thumbnails/gradletheandroid-160422024052-thumbnail.jpg?width=560&fit=bounds)
Ad
More Related Content
What's hot (19)
Similar to N api - node interactive 2017 (20)
Ad
More from Michael Dawson (17)
Ad
Recently uploaded (20)
![Get & Download Wondershare Filmora Crack Latest [2025]](https://cdn.slidesharecdn.com/ss_thumbnails/revolutionizingresidentialwi-fi-250422112639-60fb726f-250429170801-59e1b240-thumbnail.jpg?width=560&fit=bounds)
N api - node interactive 2017
- 1. N-API: Next Generation Node API for native modules Arunesh Chandra, Microsoft Michael Dawson, IBM
- 2. Arunesh Chandra, Microsoft Senior Program Manager @ Microsoft Node-ChakraCore Project Time-Travel Debugging Contact me: [email protected] Twitter: @AruneshC Github: @aruneshchandra
- 3. Michael Dawson, IBM Senior Software Developer @ IBM IBM Node.js community lead/IBM Runtime Technologies Node.js collaborator, and TSC member Active in LTS, build, benchmarking, api and post-mortem working groups Contact me: [email protected] Twitter: @mhdawson1 Github: @mhdawson Linkedin: https://www.linkedin.com/in/michael-dawson-6051282
- 4. Contributors
- 5. What is N-API ? N-API is a stable Node API layer for native modules, that provides ABI compatibility guarantees across different Node versions & flavors. N-API enables native modules to just work across different versions and flavors of Node.js without recompilations!
- 6. N-API available as Experimental in Node.js 8!
- 7. Why do I care about N-API ? Reduces maintenance cost for Native module maintainers Reduces friction from upgrading to newer Node.js versions in production deployments
- 8. The response so far …
- 9. Is it the new NaN ? • N-API has more complete isolation from V8 • Compile once/run multiple versions • Both C and C++ usage supported • N-API expected to replace NaN usage
- 10. Ported Modules • Node-Sass • Canvas • SQLlite • LevelDown • Nanomsg • IoTivity
- 12. API Shape napi_status napi_create_array(napi_env env, napi_value* result); napi_status napi_get_last_error_info(napi_env e, const napi_extended_error_info** result); napi_status napi_is_exception_pending(napi_env e, bool* result); napi_status napi_get_and_clear_last_exception(napi_env e, napi_value* result); napi_status napi_throw(napi_env e, napi_value error); • Collection of C APIs available natively in Node.js 8.0 • API Docs - https://nodejs.org/dist/latest-v8.x/docs/api/n-api.html • ../src/node_api.h
- 13. Examples – C- API #include <node_api.h> napi_value RunCallback(napi_env env, const napi_callback_info info) { ... } #define DECLARE_NAPI_METHOD(name, func) { name, 0, func, 0, 0, 0, napi_default, 0 } napi_value Init(napi_env env, napi_value exports) { napi_value new_exports; napi_status status = napi_create_function(env, "", NAPI_AUTO_LENGTH, RunCallback, nullptr, &new_exports); assert(status == napi_ok); return new_exports; } NAPI_MODULE(addon, Init); https://github.com/nodejs/abi-stable-node-addon-examples 3_callbacks
- 14. Examples – C- API #include <node_api.h> napi_value RunCallback(napi_env env, const napi_callback_info info) { napi_status status; size_t argc = 1; napi_value args[1]; status = napi_get_cb_info(env, info, &argc, args, nullptr, nullptr); napi_value cb = args[0]; napi_value argv[1]; status = napi_create_string_utf8(env, "hello world", NAPI_AUTO_LENGTH, argv); napi_value global; status = napi_get_global(env, &global); napi_value result; status = napi_call_function(env, global, cb, 1, argv, &result); return nullptr; } optional 'this' optional 'data pointer' optional length NODE_BUILD=/home/mhdawson/newpull/io.js export PATH=$NODE_BUILD:$NODE_BUILD/../abi-stable-node-addon- examples/node_modules/node-gyp/bin/:$PATH export NPM=$NODE_BUILD/deps/npm/bin/npm-cli.js alias npm=$NPM alias node-gyp=node-gyp.js export npm_config_nodedir=$NODE_BUILD
- 15. Example – C++ Wrapper Module https://github.com/nodejs/node-addon-api https://www.npmjs.com/package/node-addon-api https://nodejs.github.io/node-addon-api/namespace_napi.html
- 16. Example – C++ Wrapper Example NaN node-addon-api void Init(v8::Local<v8::Object> exports, v8::Local<v8::Object> module) { Nan::SetMethod(module, "exports", RunCallback); } void RunCallback(const Napi::CallbackInfo& info) { Napi::Env env = info.Env(); Napi::Function cb = info[0].As<Napi::Function>(); cb.MakeCallback(env.Global(), { Napi::String::New(env, "hello world") }); } https://github.com/nodejs/abi-stable-node-addon-examples/tree/master/3_callbacks/node-addon-api https://github.com/nodejs/node-addon-api/blob/master/tools/conversion.js #include <nan.h> void RunCallback(const Nan::FunctionCallbackInfo<v8::Value>& info) { v8::Local<v8::Function> cb = info[0].As<v8::Function>(); const unsigned argc = 1; v8::Local<v8::Value> argv[argc] = { Nan::New("hello world").ToLocalChecked() }; Nan::MakeCallback(Nan::GetCurrentContext()->Global(), cb, argc, argv); } NODE_MODULE(addon, Init) #include <napi.h> Napi::Object Init(Napi::Env env, Napi::Object exports) { return Napi::Function::New(env, RunCallback); } NODE_API_MODULE(addon, Init)
- 17. Backward Compatibility • Available in 8.x • Plan to backport to 6.x • For 4.x • Copy of API built into node-addon-api module • Do NOT get build once/run any version • Can maintain module with single code base
- 18. Calling all native module maintainers and Node.js enthusiasts • Help wanted to port popular native modules • Try out one of the ported modules and provide feedback • Improve the documentation • Improve test coverage • Join the N-API Working Group https://github.com/nodejs/abi-stable-node
- 19. Useful Links • Conversion tool for migrating existing NaN modules to N-API https://github.com/nodejs/node-addon-api/blob/master/tools/conversion.js • Yeoman generator for building N-API module from scratch https://github.com/digitalinfinity/generator-napi-module (C++ Wrapper) • Guidance for publishing N-API versions of your modules https://nodejs.org/en/docs/guides/publishing-napi-modules/
- 20. Copyright and Trademarks © IBM Corporation and Microsoft Corporation, 2017. All Rights Reserved IBM, the IBM logo, ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at “Copyright and trademark information” at www.ibm.com/legal/copytrade.shtml Microsoft is a trademark of Microsoft Corporation in the United States, other countries, or both. Node.js is an official trademark of Joyent. IBM SDK for Node.js is not formally related to or endorsed by the official Joyent Node.js open source or commercial project. Java, JavaScript and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. npm is a trademark of npm, Inc.
Editor's Notes
- #2: Welcome to this talk on N-API! How many of you have heard of N-API ? Well this is a joint talk, I’m going to start of and give you an overview of what and why and show you a demo Michael will dive deeper and talk about the nuts and bolts about the API So let’s get started!
- #6: Today due to the lack of ABI stability in Node.js - the native node module ecosystem suffers from breakage for every new Node release. According to some estimates approc 30% of the module ecosystem gets impacted by this. Module maintainers have to invest time to update their support for new versions and module consumers don’t upgrade their node versions due to these compatibility issues.
- #8: N-API enabled modules will improve experience for module consumers – it will reduce friction in upgrading to new versions and also reduce maintaince cost for the module maintainers
- #9: The community certainly feels really good about this new feature in Node.js 8
- #10: Well you can say how is it different from NaN ?
- #11: While designing and implementing N-API – we have converted these popular native modules to N-API
- #13: Common error handling patterns - returns status – if 0 all ok - if non-zero check status and/or pending exception Result passed back as in/out parameter
- #15: napi_get_cb_info all but env and info are optional