Added working node-addon-api examples for examples

Anisha Rohra · mhdawson · commit b847923cd93b · 2017-09-27T09:35:47.000-04:00
PR-URL: nodejs/abi-stable-node-addon-examples#8 Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Sampson Gao <sampsong@ca.ibm.com>
diff --git a/1_hello_world/node-addon-api/hello.cc b/1_hello_world/node-addon-api/hello.cc
@@ -1,14 +1,14 @@
 #include <napi.h>
-#include <uv.h>
 
 Napi::String Method(const Napi::CallbackInfo& info) {
   Napi::Env env = info.Env();
   return Napi::String::New(env, "world");
 }
 
-void Init(Napi::Env env, Napi::Object exports, Napi::Object module) {
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
   exports.Set(Napi::String::New(env, "hello"),
               Napi::Function::New(env, Method));
+  return exports;
 }
 
 NODE_API_MODULE(hello, Init)
diff --git a/2_function_arguments/node-addon-api/addon.cc b/2_function_arguments/node-addon-api/addon.cc
@@ -0,0 +1,29 @@
+#include <napi.h>
+
+Napi::Value Add(const Napi::CallbackInfo& info) {
+  Napi::Env env = info.Env();
+
+  if (info.Length() < 2) {
+    Napi::TypeError::New(env, "Wrong number of arguments").ThrowAsJavaScriptException();
+    return env.Null();
+  }
+
+  if (!info[0].IsNumber() || !info[1].IsNumber()) {
+    Napi::TypeError::New(env, "Wrong arguments").ThrowAsJavaScriptException();
+    return env.Null();
+  }
+
+  double arg0 = info[0].As<Napi::Number>().DoubleValue();
+  double arg1 = info[1].As<Napi::Number>().DoubleValue();
+  Napi::Number num = Napi::Number::New(env, arg0 + arg1);
+
+  return num;
+}
+
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
+  exports.Set(Napi::String::New(env, "add"),
+              Napi::Function::New(env, Add));
+  return exports;
+}
+
+NODE_API_MODULE(addon, Init)
diff --git a/2_function_arguments/node-addon-api/addon.js b/2_function_arguments/node-addon-api/addon.js
@@ -0,0 +1,3 @@
+var addon = require('bindings')('addon.node')
+
+console.log('This should be eight:', addon.add(3, 5))
diff --git a/2_function_arguments/node-addon-api/binding.gyp b/2_function_arguments/node-addon-api/binding.gyp
@@ -0,0 +1,14 @@
+{
+  "targets": [
+    {
+      "target_name": "addon",
+      "cflags!": [ "-fno-exceptions" ],
+      "cflags_cc!": [ "-fno-exceptions" ],
+      "sources": [ "addon.cc" ],
+      "include_dirs": [
+        "<!@(node -p \"require('node-addon-api').include\")"
+      ],
+      'defines': [ 'NAPI_DISABLE_CPP_EXCEPTIONS' ],
+    }
+  ]
+}
diff --git a/2_function_arguments/node-addon-api/package.json b/2_function_arguments/node-addon-api/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "function_arguments",
+  "version": "0.0.0",
+  "description": "Node.js Addons Example #2",
+  "main": "addon.js",
+  "private": true,
+  "dependencies": {
+    "bindings": "~1.2.1",
+    "node-addon-api": "^0.6.3"
+  },
+  "scripts": {
+    "test": "node addon.js"
+  },
+  "gypfile": true
+}
diff --git a/3_callbacks/node-addon-api/addon.cc b/3_callbacks/node-addon-api/addon.cc
@@ -0,0 +1,13 @@
+#include <napi.h>
+
+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") });
+}
+
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
+  return Napi::Function::New(env, RunCallback);
+}
+
+NODE_API_MODULE(addon, Init)
diff --git a/3_callbacks/node-addon-api/addon.js b/3_callbacks/node-addon-api/addon.js
@@ -0,0 +1,5 @@
+var addon = require('bindings')('addon');
+
+addon(function(msg){
+  console.log(msg); // 'hello world'
+});
diff --git a/3_callbacks/node-addon-api/binding.gyp b/3_callbacks/node-addon-api/binding.gyp
@@ -0,0 +1,14 @@
+{
+  "targets": [
+    {
+      "target_name": "addon",
+      "cflags!": [ "-fno-exceptions" ],
+      "cflags_cc!": [ "-fno-exceptions" ],
+      "sources": [ "addon.cc" ],
+      "include_dirs": [
+        "<!@(node -p \"require('node-addon-api').include\")"
+      ],
+      'defines': [ 'NAPI_DISABLE_CPP_EXCEPTIONS' ],
+    }
+  ]
+}
diff --git a/3_callbacks/node-addon-api/package.json b/3_callbacks/node-addon-api/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "callbacks",
+  "version": "0.0.0",
+  "description": "Node.js Addons Example #3",
+  "main": "addon.js",
+  "private": true,
+  "gypfile": true,
+  "dependencies": {
+    "bindings": "~1.2.1",
+    "node-addon-api": "^0.6.3"
+  }
+}
diff --git a/4_object_factory/node-addon-api/addon.cc b/4_object_factory/node-addon-api/addon.cc
@@ -0,0 +1,15 @@
+#include <napi.h>
+
+Napi::Object CreateObject(const Napi::CallbackInfo& info) {
+  Napi::Env env = info.Env();
+  Napi::Object obj = Napi::Object::New(env);
+  obj.Set(Napi::String::New(env, "msg"), info[0].ToString());
+
+  return obj;
+}
+
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
+  return Napi::Function::New(env, CreateObject, "createObject");
+}
+
+NODE_API_MODULE(addon, Init)
diff --git a/4_object_factory/node-addon-api/addon.js b/4_object_factory/node-addon-api/addon.js
@@ -0,0 +1,5 @@
+var addon = require('bindings')('addon');
+
+var obj1 = addon('hello');
+var obj2 = addon('world');
+console.log(obj1.msg+' '+obj2.msg); // 'hello world'
diff --git a/4_object_factory/node-addon-api/binding.gyp b/4_object_factory/node-addon-api/binding.gyp
@@ -0,0 +1,14 @@
+{
+  "targets": [
+    {
+      "target_name": "addon",
+      "cflags!": [ "-fno-exceptions" ],
+      "cflags_cc!": [ "-fno-exceptions" ],
+      "sources": [ "addon.cc" ],
+      "include_dirs": [
+        "<!@(node -p \"require('node-addon-api').include\")"
+      ],
+      'defines': [ 'NAPI_DISABLE_CPP_EXCEPTIONS' ],
+    }
+  ]
+}
diff --git a/4_object_factory/node-addon-api/package.json b/4_object_factory/node-addon-api/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "object_factory",
+  "version": "0.0.0",
+  "description": "Node.js Addons Example #4",
+  "main": "addon.js",
+  "private": true,
+  "gypfile": true,
+  "dependencies": {
+    "bindings": "~1.2.1",
+    "node-addon-api": "^0.6.3"
+  }
+}
diff --git a/5_function_factory/node-addon-api/addon.cc b/5_function_factory/node-addon-api/addon.cc
@@ -0,0 +1,18 @@
+#include <napi.h>
+
+Napi::String MyFunction(const Napi::CallbackInfo& info) {
+  Napi::Env env = info.Env();
+  return Napi::String::New(env, "hello world");
+}
+
+Napi::Function CreateFunction(const Napi::CallbackInfo& info) {
+  Napi::Env env = info.Env();
+  Napi::Function fn = Napi::Function::New(env, MyFunction, "theFunction");
+  return fn;
+}
+
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
+  return Napi::Function::New(env, CreateFunction, "createObject");
+}
+
+NODE_API_MODULE(addon, Init)
diff --git a/5_function_factory/node-addon-api/addon.js b/5_function_factory/node-addon-api/addon.js
@@ -0,0 +1,4 @@
+var addon = require('bindings')('addon');
+
+var fn = addon();
+console.log(fn()); // 'hello world'
diff --git a/5_function_factory/node-addon-api/binding.gyp b/5_function_factory/node-addon-api/binding.gyp
@@ -0,0 +1,14 @@
+{
+  "targets": [
+    {
+      "target_name": "addon",
+      "cflags!": [ "-fno-exceptions" ],
+      "cflags_cc!": [ "-fno-exceptions" ],
+      "sources": [ "addon.cc" ],
+      "include_dirs": [
+        "<!@(node -p \"require('node-addon-api').include\")"
+      ],
+      'defines': [ 'NAPI_DISABLE_CPP_EXCEPTIONS' ],
+    }
+  ]
+}
diff --git a/5_function_factory/node-addon-api/package.json b/5_function_factory/node-addon-api/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "function_factory",
+  "version": "0.0.0",
+  "description": "Node.js Addons Example #5",
+  "main": "addon.js",
+  "private": true,
+  "gypfile": true,
+  "dependencies": {
+    "bindings": "~1.2.1",
+    "node-addon-api": "^0.6.3"
+  }
+}
diff --git a/6_object_wrap/node-addon-api/addon.cc b/6_object_wrap/node-addon-api/addon.cc
@@ -0,0 +1,8 @@
+#include <napi.h>
+#include "myobject.h"
+
+Napi::Object InitAll(Napi::Env env, Napi::Object exports) {
+  return MyObject::Init(env, exports);
+}
+
+NODE_API_MODULE(addon, InitAll)
diff --git a/6_object_wrap/node-addon-api/addon.js b/6_object_wrap/node-addon-api/addon.js
@@ -0,0 +1,13 @@
+var addon = require('bindings')('addon');
+
+var obj = new addon.MyObject(10);
+console.log( obj.plusOne() ); // 11
+console.log( obj.plusOne() ); // 12
+console.log( obj.plusOne() ); // 13
+
+console.log( obj.multiply().value() ); // 13
+console.log( obj.multiply(10).value() ); // 130
+
+var newobj = obj.multiply(-1);
+console.log( newobj.value() ); // -13
+console.log( obj === newobj ); // false
diff --git a/6_object_wrap/node-addon-api/binding.gyp b/6_object_wrap/node-addon-api/binding.gyp
@@ -0,0 +1,14 @@
+{
+  "targets": [
+    {
+      "target_name": "addon",
+      "cflags!": [ "-fno-exceptions" ],
+      "cflags_cc!": [ "-fno-exceptions" ],
+      "sources": [ "addon.cc", "myobject.cc" ],
+      "include_dirs": [
+        "<!@(node -p \"require('node-addon-api').include\")"
+      ],
+      'defines': [ 'NAPI_DISABLE_CPP_EXCEPTIONS' ],
+    }
+  ]
+}
diff --git a/6_object_wrap/node-addon-api/myobject.cc b/6_object_wrap/node-addon-api/myobject.cc
@@ -0,0 +1,58 @@
+#include "myobject.h"
+
+Napi::FunctionReference MyObject::constructor;
+
+Napi::Object MyObject::Init(Napi::Env env, Napi::Object exports) {
+  Napi::HandleScope scope(env);
+
+  Napi::Function func = DefineClass(env, "MyObject", {
+    InstanceMethod("plusOne", &MyObject::PlusOne),
+    InstanceMethod("value", &MyObject::GetValue),
+    InstanceMethod("multiply", &MyObject::Multiply)
+  });
+
+  constructor = Napi::Persistent(func);
+  constructor.SuppressDestruct();
+
+  exports.Set("MyObject", func);
+  return exports;
+}
+
+MyObject::MyObject(const Napi::CallbackInfo& info) : Napi::ObjectWrap<MyObject>(info)  {
+  Napi::Env env = info.Env();
+  Napi::HandleScope scope(env);
+
+  int length = info.Length();
+
+  if (length <= 0 || !info[0].IsNumber()) {
+    Napi::TypeError::New(env, "Number expected").ThrowAsJavaScriptException();
+  }
+
+  Napi::Number value = info[0].As<Napi::Number>();
+  this->value_ = value.DoubleValue();
+}
+
+Napi::Value MyObject::GetValue(const Napi::CallbackInfo& info) {
+  double num = this->value_;
+
+  return Napi::Number::New(info.Env(), num);
+}
+
+Napi::Value MyObject::PlusOne(const Napi::CallbackInfo& info) {
+  this->value_ = this->value_ + 1;
+
+  return MyObject::GetValue(info);
+}
+
+Napi::Value MyObject::Multiply(const Napi::CallbackInfo& info) {
+  Napi::Number multiple;
+  if (info.Length() <= 0 || !info[0].IsNumber()) {
+    multiple = Napi::Number::New(info.Env(), 1);
+  } else {
+    multiple = info[0].As<Napi::Number>();
+  }
+
+  Napi::Object obj = constructor.New({ Napi::Number::New(info.Env(), this->value_ * multiple.DoubleValue()) });
+
+  return obj;
+}
diff --git a/6_object_wrap/node-addon-api/myobject.h b/6_object_wrap/node-addon-api/myobject.h
@@ -0,0 +1,22 @@
+#ifndef MYOBJECT_H
+#define MYOBJECT_H
+
+#include <napi.h>
+
+class MyObject : public Napi::ObjectWrap<MyObject> {
+ public:
+  static Napi::Object Init(Napi::Env env, Napi::Object exports);
+  MyObject(const Napi::CallbackInfo& info);
+
+ private:
+  static Napi::FunctionReference constructor;
+
+  Napi::Value GetValue(const Napi::CallbackInfo& info);
+  Napi::Value PlusOne(const Napi::CallbackInfo& info);
+  Napi::Value Multiply(const Napi::CallbackInfo& info);
+
+  double value_;
+
+};
+
+#endif
diff --git a/6_object_wrap/node-addon-api/package.json b/6_object_wrap/node-addon-api/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "object_wrap",
+  "version": "0.0.0",
+  "description": "Node.js Addons Example #6",
+  "main": "addon.js",
+  "private": true,
+  "gypfile": true,
+  "dependencies": {
+    "bindings": "~1.2.1",
+    "node-addon-api": "^0.6.3"
+  }
+}
diff --git a/7_factory_wrap/node-addon-api/addon.cc b/7_factory_wrap/node-addon-api/addon.cc
@@ -0,0 +1,13 @@
+#include <napi.h>
+#include "myobject.h"
+
+Napi::Object CreateObject(const Napi::CallbackInfo& info) {
+  return MyObject::NewInstance(info.Env(), info[0]);
+}
+
+Napi::Object InitAll(Napi::Env env, Napi::Object exports) {
+  Napi::Object new_exports = Napi::Function::New(env, CreateObject, "CreateObject");
+  return MyObject::Init(env, new_exports);
+}
+
+NODE_API_MODULE(addon, InitAll)
diff --git a/7_factory_wrap/node-addon-api/addon.js b/7_factory_wrap/node-addon-api/addon.js
@@ -0,0 +1,11 @@
+var createObject = require('bindings')('addon');
+
+var obj = createObject(10);
+console.log( obj.plusOne() ); // 11
+console.log( obj.plusOne() ); // 12
+console.log( obj.plusOne() ); // 13
+
+var obj2 = createObject(20);
+console.log( obj2.plusOne() ); // 21
+console.log( obj2.plusOne() ); // 22
+console.log( obj2.plusOne() ); // 23
diff --git a/7_factory_wrap/node-addon-api/binding.gyp b/7_factory_wrap/node-addon-api/binding.gyp
diff --git a/7_factory_wrap/node-addon-api/myobject.cc b/7_factory_wrap/node-addon-api/myobject.cc
diff --git a/7_factory_wrap/node-addon-api/myobject.h b/7_factory_wrap/node-addon-api/myobject.h
diff --git a/7_factory_wrap/node-addon-api/package.json b/7_factory_wrap/node-addon-api/package.json
diff --git a/8_passing_wrapped/node-addon-api/addon.cc b/8_passing_wrapped/node-addon-api/addon.cc
diff --git a/8_passing_wrapped/node-addon-api/addon.js b/8_passing_wrapped/node-addon-api/addon.js
diff --git a/8_passing_wrapped/node-addon-api/binding.gyp b/8_passing_wrapped/node-addon-api/binding.gyp
diff --git a/8_passing_wrapped/node-addon-api/myobject.cc b/8_passing_wrapped/node-addon-api/myobject.cc
diff --git a/8_passing_wrapped/node-addon-api/myobject.h b/8_passing_wrapped/node-addon-api/myobject.h
diff --git a/8_passing_wrapped/node-addon-api/package.json b/8_passing_wrapped/node-addon-api/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,14 +1,14 @@`
`1`	`1`	`#include <napi.h>`
`2`		`-#include <uv.h>`
`3`	`2`
`4`	`3`	`Napi::String Method(const Napi::CallbackInfo& info) {`
`5`	`4`	`Napi::Env env = info.Env();`
`6`	`5`	`return Napi::String::New(env, "world");`
`7`	`6`	`}`
`8`	`7`
`9`		`-void Init(Napi::Env env, Napi::Object exports, Napi::Object module) {`
	`8`	`+Napi::Object Init(Napi::Env env, Napi::Object exports) {`
`10`	`9`	`exports.Set(Napi::String::New(env, "hello"),`
`11`	`10`	`Napi::Function::New(env, Method));`
	`11`	`+ return exports;`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`NODE_API_MODULE(hello, Init)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+var addon = require('bindings')('addon.node')`
	`2`	`+`
	`3`	`+console.log('This should be eight:', addon.add(3, 5))`