Adds additional tutorial examples

jschlight · jschlight · commit 4435100def58 · 2020-02-27T16:52:01.000-08:00
diff --git a/a-first-project/node-addon-api/README.md b/a-first-project/node-addon-api/README.md
@@ -0,0 +1,14 @@
+# N-API A First Project
+
+This is an example project that accompanies the N-API workshop tutorials
+
+A tutorial describing this project can be found at the [N-API Resource](https://napi.inspiredware.com/getting-started/first.html).
+
+To build and run this program on your system, clone it to your computer and run these two commands inside your clone:
+
+```
+npm install
+npm test
+```
+
+> You need to have Node 10.5.0 or later installed. 
diff --git a/a-first-project/node-addon-api/binding.gyp b/a-first-project/node-addon-api/binding.gyp
@@ -0,0 +1,20 @@
+{
+  'targets': [
+    {
+      'target_name': 'hello-world-native',
+      'sources': [ 'src/hello_world.cc' ],
+      'include_dirs': ["<!@(node -p \"require('node-addon-api').include\")"],
+      'dependencies': ["<!(node -p \"require('node-addon-api').gyp\")"],
+      'cflags!': [ '-fno-exceptions' ],
+      'cflags_cc!': [ '-fno-exceptions' ],
+      'xcode_settings': {
+        'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
+        'CLANG_CXX_LIBRARY': 'libc++',
+        'MACOSX_DEPLOYMENT_TARGET': '10.7'
+      },
+      'msvs_settings': {
+        'VCCLCompilerTool': { 'ExceptionHandling': 1 },
+      }
+    }
+  ]
+}
diff --git a/a-first-project/node-addon-api/lib/binding.js b/a-first-project/node-addon-api/lib/binding.js
@@ -0,0 +1,4 @@
+const addon = require('../build/Release/hello-world-native');
+
+module.exports = addon.HelloWorld
+
diff --git a/a-first-project/node-addon-api/package.json b/a-first-project/node-addon-api/package.json
@@ -0,0 +1,16 @@
+{
+  "main": "lib/binding.js",
+  "private": true,
+  "dependencies": {
+    "node-addon-api": "^1.1.0"
+  },
+  "scripts": {
+    "test": "node --napi-modules ./test/test_binding.js"
+  },
+  "gypfile": true,
+  "name": "hello-world",
+  "version": "1.0.0",
+  "description": "A first project.",
+  "author": "Your name goes here",
+  "license": "ISC"
+}
diff --git a/a-first-project/node-addon-api/src/hello_world.cc b/a-first-project/node-addon-api/src/hello_world.cc
@@ -0,0 +1,16 @@
+#include <napi.h>
+
+using namespace Napi;
+
+Napi::String Method(const Napi::CallbackInfo& info) {
+  Napi::Env env = info.Env();
+  return Napi::String::New(env, "world");
+}
+
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
+  exports.Set(Napi::String::New(env, "HelloWorld"),
+              Napi::Function::New(env, Method));
+  return exports;
+}
+
+NODE_API_MODULE(addon, Init)
diff --git a/a-first-project/node-addon-api/test/test_binding.js b/a-first-project/node-addon-api/test/test_binding.js
@@ -0,0 +1,14 @@
+const HelloWorld = require("../lib/binding.js");
+const assert = require("assert");
+
+assert(HelloWorld, "The expected function is undefined");
+
+function testBasic()
+{
+    const result =  HelloWorld("hello");
+    assert.strictEqual(result, "world", "Unexpected value returned");
+}
+
+assert.doesNotThrow(testBasic, undefined, "testBasic threw an expection");
+
+console.log("Tests passed- everything looks OK!");
diff --git a/function-reference-demo/node-addon-api/binding.gyp b/function-reference-demo/node-addon-api/binding.gyp
@@ -0,0 +1,31 @@
+{
+  "targets": [
+    {
+      "target_name": "addon",
+      "sources": [
+        "src/binding.cc",
+        "src/native-addon.cc"
+      ],
+      'cflags!': [ '-fno-exceptions' ],
+      'cflags_cc!': [ '-fno-exceptions' ],
+      'include_dirs': ["<!@(node -p \"require('node-addon-api').include\")"],
+      'dependencies': ["<!(node -p \"require('node-addon-api').gyp\")"],
+      'conditions': [
+        ['OS=="win"', {
+          "msvs_settings": {
+            "VCCLCompilerTool": {
+              "ExceptionHandling": 1
+            }
+          }
+        }],
+        ['OS=="mac"', {
+          "xcode_settings": {
+            "CLANG_CXX_LIBRARY": "libc++",
+            'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
+            'MACOSX_DEPLOYMENT_TARGET': '10.7'
+          }
+        }]
+      ]
+    }
+  ]
+}
diff --git a/function-reference-demo/node-addon-api/index.js b/function-reference-demo/node-addon-api/index.js
@@ -0,0 +1,27 @@
+'use strict'
+
+const { NativeAddon } = require('bindings')('addon')
+
+function JSFnRef() {
+    console.log('Hi! I\'m a JS function reference!')
+}
+
+function JSFn() {
+    console.log('Hi! I\'m a JS function!')
+}
+
+const ITERATIONS = 5
+
+const addon = new NativeAddon(JSFnRef, JSFn)
+
+for (let i = 0; i < ITERATIONS; i++) {
+    addon.tryCallByStoredReference()
+}
+
+try {
+    addon.tryCallByStoredFunction()
+} catch (err) {
+    console.error('This code crashes because JSFn is valid only inside the constructor function.')
+    console.error('The lifespan of the JSFn function is limited to the execution of the constructor function.')
+    console.error('After that, the function stored in JSFn is ready to be garbage collected and it cannot be used anymore.')
+}
diff --git a/function-reference-demo/node-addon-api/package.json b/function-reference-demo/node-addon-api/package.json
@@ -0,0 +1,14 @@
+{
+  "name": "function-reference-demo",
+  "version": "0.0.0",
+  "description": "Tutorial example showing the use of function references.",
+  "main": "index.js",
+  "gypfile": true,
+  "scripts": {
+    "start": "node index.js"
+  },
+  "dependencies": {
+    "node-addon-api": "*",
+    "bindings": "*"
+  }
+}
diff --git a/function-reference-demo/node-addon-api/src/binding.cc b/function-reference-demo/node-addon-api/src/binding.cc
@@ -0,0 +1,9 @@
+#include <napi.h>
+#include "native-addon.h"
+
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
+    NativeAddon::Init(env, exports);
+    return exports;
+}
+
+NODE_API_MODULE(NODE_GYP_MODULE_NAME, Init)
diff --git a/function-reference-demo/node-addon-api/src/native-addon.cc b/function-reference-demo/node-addon-api/src/native-addon.cc
@@ -0,0 +1,35 @@
+#include "native-addon.h"
+#include <iostream>
+
+Napi::FunctionReference NativeAddon::constructor;
+
+Napi::Object NativeAddon::Init(Napi::Env env, Napi::Object exports) {
+  Napi::HandleScope scope(env);
+  
+  Napi::Function func = DefineClass(env, "NativeAddon", {
+    InstanceMethod("tryCallByStoredReference", &NativeAddon::TryCallByStoredReference),
+    InstanceMethod("tryCallByStoredFunction", &NativeAddon::TryCallByStoredFunction)
+  });
+
+  constructor = Napi::Persistent(func);
+  constructor.SuppressDestruct();
+
+  exports.Set("NativeAddon", func);
+  return exports;
+}
+
+NativeAddon::NativeAddon(const Napi::CallbackInfo& info) 
+: Napi::ObjectWrap<NativeAddon>(info)  {
+  jsFnRef = Napi::Persistent(info[0].As<Napi::Function>());
+  jsFn = info[1].As<Napi::Function>();
+}
+
+void NativeAddon::TryCallByStoredReference(const Napi::CallbackInfo& info) {
+    // Napi::Env env = info.Env();
+    jsFnRef.Call({});
+}
+
+void NativeAddon::TryCallByStoredFunction(const Napi::CallbackInfo& info) {
+    // Napi::Env env = info.Env();
+    jsFn.Call({});
+}
diff --git a/function-reference-demo/node-addon-api/src/native-addon.h b/function-reference-demo/node-addon-api/src/native-addon.h
@@ -0,0 +1,15 @@
+#include <napi.h>
+
+class NativeAddon : public Napi::ObjectWrap<NativeAddon> {
+    public:
+        static Napi::Object Init(Napi::Env env, Napi::Object exports);
+        NativeAddon(const Napi::CallbackInfo& info);
+        
+    private:
+        static Napi::FunctionReference constructor;
+        Napi::FunctionReference jsFnRef;
+        Napi::Function jsFn;
+
+        void TryCallByStoredReference(const Napi::CallbackInfo& info);
+        void TryCallByStoredFunction(const Napi::CallbackInfo& info);
+};
diff --git a/napi-asyncworker-example/node-addon-api/README.md b/napi-asyncworker-example/node-addon-api/README.md
@@ -0,0 +1,14 @@
+# N-API AsyncWorker Example
+
+This is an example project showing how to use the Node.js N-API AsyncWorker class
+
+A tutorial describing this project can be found at the [N-API Resource](https://napi.inspiredware.com/special-topics/asyncworker.html).
+
+To build and run this program on your system, clone it to your computer and run these two commands inside your clone:
+
+```
+npm install
+npm test
+```
+
+> You need to have Node 10.5.0 or later installed. 
diff --git a/napi-asyncworker-example/node-addon-api/binding.gyp b/napi-asyncworker-example/node-addon-api/binding.gyp
@@ -0,0 +1,20 @@
+{
+  'targets': [
+    {
+      'target_name': 'napi-asyncworker-example-native',
+      'sources': [ 'src/RunSimpleAsyncWorker.cc', 'src/SimpleAsyncWorker.cc' ],
+      'include_dirs': ["<!@(node -p \"require('node-addon-api').include\")"],
+      'dependencies': ["<!(node -p \"require('node-addon-api').gyp\")"],
+      'cflags!': [ '-fno-exceptions' ],
+      'cflags_cc!': [ '-fno-exceptions' ],
+      'xcode_settings': {
+        'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
+        'CLANG_CXX_LIBRARY': 'libc++',
+        'MACOSX_DEPLOYMENT_TARGET': '10.7'
+      },
+      'msvs_settings': {
+        'VCCLCompilerTool': { 'ExceptionHandling': 1 },
+      }
+    }
+  ]
+}
diff --git a/napi-asyncworker-example/node-addon-api/package.json b/napi-asyncworker-example/node-addon-api/package.json
@@ -0,0 +1,23 @@
+{
+  "name": "napi-asyncworker-example",
+  "description": "An example project showing how to use the Node.js N-API AsyncWorker class",
+  "version": "1.0.0",
+  "main": "test/Test.js",
+  "dependencies": {
+    "node-addon-api": "^1.1.0"
+  },
+  "scripts": {
+    "test": "node --napi-modules ./test/Test.js"
+  },
+  "gypfile": true,
+  "keywords": [
+    "node",
+    "napi",
+    "n-api",
+    "async",
+    "asyncworker",
+    "example"
+  ],
+  "author": "Jim Schlight",
+  "license": "MIT"
+}
diff --git a/napi-asyncworker-example/node-addon-api/src/RunSimpleAsyncWorker.cc b/napi-asyncworker-example/node-addon-api/src/RunSimpleAsyncWorker.cc
@@ -0,0 +1,17 @@
+#include "SimpleAsyncWorker.h"
+
+Value runSimpleAsyncWorker(const CallbackInfo& info) {
+    int runTime = info[0].As<Number>();
+    Function callback = info[1].As<Function>();
+    SimpleAsyncWorker* asyncWorker = new SimpleAsyncWorker(callback, runTime);
+    asyncWorker->Queue();
+    std::string msg = "SimpleAsyncWorker for " + std::to_string(runTime) + " seconds queued.";
+    return String::New(info.Env(),msg.c_str());
+};
+
+Object Init(Env env, Object exports) {
+    exports["runSimpleAsyncWorker"] = Function::New(env, runSimpleAsyncWorker, std::string("runSimpleAsyncWorker"));
+    return exports;
+}
+
+NODE_API_MODULE(addon, Init)
diff --git a/napi-asyncworker-example/node-addon-api/src/SimpleAsyncWorker.cc b/napi-asyncworker-example/node-addon-api/src/SimpleAsyncWorker.cc
@@ -0,0 +1,16 @@
+#include "SimpleAsyncWorker.h"
+#include <chrono>
+#include <thread>
+
+SimpleAsyncWorker::SimpleAsyncWorker(Function& callback, int runTime)
+    : AsyncWorker(callback), runTime(runTime) {};
+
+void SimpleAsyncWorker::Execute() {
+    std::this_thread::sleep_for(std::chrono::seconds(runTime));
+    if (runTime == 4) SetError ("Oops! Failed after 'working' 4 seconds.");
+};
+
+void SimpleAsyncWorker::OnOK() {
+    std::string msg = "SimpleAsyncWorker returning after 'working' " + std::to_string(runTime) + " seconds.";
+    Callback().Call({Env().Null(), String::New(Env(), msg)});
+};
diff --git a/napi-asyncworker-example/node-addon-api/src/SimpleAsyncWorker.h b/napi-asyncworker-example/node-addon-api/src/SimpleAsyncWorker.h
@@ -0,0 +1,16 @@
+#pragma once
+#include <napi.h>
+using namespace Napi;
+
+class SimpleAsyncWorker : public AsyncWorker {
+    
+    public:
+        SimpleAsyncWorker(Function& callback, int runTime);
+        virtual ~SimpleAsyncWorker() {};
+
+        void Execute();
+        void OnOK();
+
+    private:
+        int runTime;
+};
diff --git a/napi-asyncworker-example/node-addon-api/test/Test.js b/napi-asyncworker-example/node-addon-api/test/Test.js
@@ -0,0 +1,18 @@
+const runWorker = require('../build/Release/napi-asyncworker-example-native');
+
+let result = runWorker.runSimpleAsyncWorker(2, AsyncWorkerCompletion);
+console.log("runSimpleAsyncWorker returned '"+result+"'.");
+
+result = runWorker.runSimpleAsyncWorker(4, AsyncWorkerCompletion);
+console.log("runSimpleAsyncWorker returned '"+result+"'.");
+
+result = runWorker.runSimpleAsyncWorker(8, AsyncWorkerCompletion);
+console.log("runSimpleAsyncWorker returned '"+result+"'.");
+
+function AsyncWorkerCompletion (err, result) {
+    if (err) {
+        console.log("SimpleAsyncWorker returned an error: ", err);
+    } else {
+        console.log("SimpleAsyncWorker returned '"+result+"'.");
+    }
+};
diff --git a/object-wrap-demo/node-addon-api/README.md b/object-wrap-demo/node-addon-api/README.md
@@ -0,0 +1,14 @@
+# N-API Object Wrap Demo
+
+This is an example project that accompanies the N-API workshop tutorials
+
+A tutorial describing this project can be found at the [N-API Resource](https://napi.inspiredware.com/getting-started/objectwrap.html).
+
+To build and run this program on your system, clone it to your computer and run these two commands inside your clone:
+
+```
+npm install
+npm test
+```
+
+> You need to have Node 10.5.0 or later installed. 
diff --git a/object-wrap-demo/node-addon-api/binding.gyp b/object-wrap-demo/node-addon-api/binding.gyp
diff --git a/object-wrap-demo/node-addon-api/lib/binding.js b/object-wrap-demo/node-addon-api/lib/binding.js
diff --git a/object-wrap-demo/node-addon-api/package.json b/object-wrap-demo/node-addon-api/package.json
diff --git a/object-wrap-demo/node-addon-api/src/object_wrap_demo.cc b/object-wrap-demo/node-addon-api/src/object_wrap_demo.cc
diff --git a/object-wrap-demo/node-addon-api/src/object_wrap_demo.h b/object-wrap-demo/node-addon-api/src/object_wrap_demo.h
diff --git a/object-wrap-demo/node-addon-api/test/test_binding.js b/object-wrap-demo/node-addon-api/test/test_binding.js

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +const addon = require('../build/Release/hello-world-native');
++
 +module.exports = addon.HelloWorld
++