136 lines
49 KiB
JSON
136 lines
49 KiB
JSON
{
|
|
"type": "module",
|
|
"source": "doc/api/addons.md",
|
|
"introduced_in": "v0.10.0",
|
|
"miscs": [
|
|
{
|
|
"textRaw": "C++ Addons",
|
|
"name": "C++ Addons",
|
|
"introduced_in": "v0.10.0",
|
|
"type": "misc",
|
|
"desc": "<p>Addons are dynamically-linked shared objects written in C++. The\n<a href=\"modules.html#modules_require_id\"><code>require()</code></a> function can load Addons as ordinary Node.js modules.\nAddons provide an interface between JavaScript and C/C++ libraries.</p>\n<p>There are three options for implementing Addons: N-API, nan, or direct\nuse of internal V8, libuv and Node.js libraries. Unless there is a need for\ndirect access to functionality which is not exposed by N-API, use N-API.\nRefer to <a href=\"n-api.html\">C/C++ Addons with N-API</a> for more information on N-API.</p>\n<p>When not using N-API, implementing Addons is complicated,\ninvolving knowledge of several components and APIs:</p>\n<ul>\n<li>\n<p>V8: the C++ library Node.js currently uses to provide the\nJavaScript implementation. V8 provides the mechanisms for creating objects,\ncalling functions, etc. V8's API is documented mostly in the\n<code>v8.h</code> header file (<code>deps/v8/include/v8.h</code> in the Node.js source\ntree), which is also available <a href=\"https://v8docs.nodesource.com/\">online</a>.</p>\n</li>\n<li>\n<p><a href=\"https://github.com/libuv/libuv\">libuv</a>: The C library that implements the Node.js event loop, its worker\nthreads and all of the asynchronous behaviors of the platform. It also\nserves as a cross-platform abstraction library, giving easy, POSIX-like\naccess across all major operating systems to many common system tasks, such\nas interacting with the filesystem, sockets, timers, and system events. libuv\nalso provides a pthreads-like threading abstraction that may be used to\npower more sophisticated asynchronous Addons that need to move beyond the\nstandard event loop. Addon authors are encouraged to think about how to\navoid blocking the event loop with I/O or other time-intensive tasks by\noff-loading work via libuv to non-blocking system operations, worker threads\nor a custom use of libuv's threads.</p>\n</li>\n<li>\n<p>Internal Node.js libraries. Node.js itself exports C++ APIs that Addons can\nuse, the most important of which is the <code>node::ObjectWrap</code> class.</p>\n</li>\n<li>\n<p>Node.js includes other statically linked libraries including OpenSSL. These\nother libraries are located in the <code>deps/</code> directory in the Node.js source\ntree. Only the libuv, OpenSSL, V8 and zlib symbols are purposefully\nre-exported by Node.js and may be used to various extents by Addons. See\n<a href=\"#addons_linking_to_libraries_included_with_node_js\">Linking to libraries included with Node.js</a> for additional information.</p>\n</li>\n</ul>\n<p>All of the following examples are available for <a href=\"https://github.com/nodejs/node-addon-examples\">download</a> and may\nbe used as the starting-point for an Addon.</p>",
|
|
"miscs": [
|
|
{
|
|
"textRaw": "Hello world",
|
|
"name": "hello_world",
|
|
"desc": "<p>This \"Hello world\" example is a simple Addon, written in C++, that is the\nequivalent of the following JavaScript code:</p>\n<pre><code class=\"language-js\">module.exports.hello = () => 'world';\n</code></pre>\n<p>First, create the file <code>hello.cc</code>:</p>\n<pre><code class=\"language-cpp\">// hello.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::NewStringType;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid Method(const FunctionCallbackInfo<Value>& args) {\n Isolate* isolate = args.GetIsolate();\n args.GetReturnValue().Set(String::NewFromUtf8(\n isolate, \"world\", NewStringType::kNormal).ToLocalChecked());\n}\n\nvoid Initialize(Local<Object> exports) {\n NODE_SET_METHOD(exports, \"hello\", Method);\n}\n\nNODE_MODULE(NODE_GYP_MODULE_NAME, Initialize)\n\n} // namespace demo\n</code></pre>\n<p>All Node.js Addons must export an initialization function following\nthe pattern:</p>\n<pre><code class=\"language-cpp\">void Initialize(Local<Object> exports);\nNODE_MODULE(NODE_GYP_MODULE_NAME, Initialize)\n</code></pre>\n<p>There is no semi-colon after <code>NODE_MODULE</code> as it's not a function (see\n<code>node.h</code>).</p>\n<p>The <code>module_name</code> must match the filename of the final binary (excluding\nthe <code>.node</code> suffix).</p>\n<p>In the <code>hello.cc</code> example, then, the initialization function is <code>Initialize</code>\nand the addon module name is <code>addon</code>.</p>\n<p>When building addons with <code>node-gyp</code>, using the macro <code>NODE_GYP_MODULE_NAME</code> as\nthe first parameter of <code>NODE_MODULE()</code> will ensure that the name of the final\nbinary will be passed to <code>NODE_MODULE()</code>.</p>",
|
|
"modules": [
|
|
{
|
|
"textRaw": "Context-aware addons",
|
|
"name": "context-aware_addons",
|
|
"desc": "<p>There are environments in which Node.js addons may need to be loaded multiple\ntimes in multiple contexts. For example, the <a href=\"https://electronjs.org/\">Electron</a> runtime runs multiple\ninstances of Node.js in a single process. Each instance will have its own\n<code>require()</code> cache, and thus each instance will need a native addon to behave\ncorrectly when loaded via <code>require()</code>. From the addon's perspective, this means\nthat it must support multiple initializations.</p>\n<p>A context-aware addon can be constructed by using the macro\n<code>NODE_MODULE_INITIALIZER</code>, which expands to the name of a function which Node.js\nwill expect to find when it loads an addon. An addon can thus be initialized as\nin the following example:</p>\n<pre><code class=\"language-cpp\">using namespace v8;\n\nextern \"C\" NODE_MODULE_EXPORT void\nNODE_MODULE_INITIALIZER(Local<Object> exports,\n Local<Value> module,\n Local<Context> context) {\n /* Perform addon initialization steps here. */\n}\n</code></pre>\n<p>Another option is to use the macro <code>NODE_MODULE_INIT()</code>, which will also\nconstruct a context-aware addon. Unlike <code>NODE_MODULE()</code>, which is used to\nconstruct an addon around a given addon initializer function,\n<code>NODE_MODULE_INIT()</code> serves as the declaration of such an initializer to be\nfollowed by a function body.</p>\n<p>The following three variables may be used inside the function body following an\ninvocation of <code>NODE_MODULE_INIT()</code>:</p>\n<ul>\n<li><code>Local<Object> exports</code>,</li>\n<li><code>Local<Value> module</code>, and</li>\n<li><code>Local<Context> context</code></li>\n</ul>\n<p>The choice to build a context-aware addon carries with it the responsibility of\ncarefully managing global static data. Since the addon may be loaded multiple\ntimes, potentially even from different threads, any global static data stored\nin the addon must be properly protected, and must not contain any persistent\nreferences to JavaScript objects. The reason for this is that JavaScript\nobjects are only valid in one context, and will likely cause a crash when\naccessed from the wrong context or from a different thread than the one on which\nthey were created.</p>\n<p>The context-aware addon can be structured to avoid global static data by\nperforming the following steps:</p>\n<ul>\n<li>\n<p>Define a class which will hold per-addon-instance data and which has a static\nmember of the form</p>\n<pre><code>```C++\nstatic void DeleteInstance(void* data) {\n // Cast `data` to an instance of the class and delete it.\n}\n```\n</code></pre>\n</li>\n<li>Heap-allocate an instance of this class in the addon initializer. This can be\naccomplished using the <code>new</code> keyword.</li>\n<li>Call <code>node::AddEnvironmentCleanupHook()</code>, passing it the above-created\ninstance and a pointer to <code>DeleteInstance()</code>. This will ensure the instance is\ndeleted when the environment is torn down.</li>\n<li>Store the instance of the class in a <code>v8::External</code>, and</li>\n<li>Pass the <code>v8::External</code> to all methods exposed to JavaScript by passing it\nto <code>v8::FunctionTemplate::New()</code> or <code>v8::Function::New()</code> which creates the\nnative-backed JavaScript functions. The third parameter of\n<code>v8::FunctionTemplate::New()</code> or <code>v8::Function::New()</code> accepts the\n<code>v8::External</code> and makes it available in the native callback using the\n<code>v8::FunctionCallbackInfo::Data()</code> method.</li>\n</ul>\n<p>This will ensure that the per-addon-instance data reaches each binding that can\nbe called from JavaScript. The per-addon-instance data must also be passed into\nany asynchronous callbacks the addon may create.</p>\n<p>The following example illustrates the implementation of a context-aware addon:</p>\n<pre><code class=\"language-cpp\">#include <node.h>\n\nusing namespace v8;\n\nclass AddonData {\n public:\n explicit AddonData(Isolate* isolate):\n call_count(0) {\n // Ensure this per-addon-instance data is deleted at environment cleanup.\n node::AddEnvironmentCleanupHook(isolate, DeleteInstance, this);\n }\n\n // Per-addon data.\n int call_count;\n\n static void DeleteInstance(void* data) {\n delete static_cast<AddonData*>(data);\n }\n};\n\nstatic void Method(const v8::FunctionCallbackInfo<v8::Value>& info) {\n // Retrieve the per-addon-instance data.\n AddonData* data =\n reinterpret_cast<AddonData*>(info.Data().As<External>()->Value());\n data->call_count++;\n info.GetReturnValue().Set((double)data->call_count);\n}\n\n// Initialize this addon to be context-aware.\nNODE_MODULE_INIT(/* exports, module, context */) {\n Isolate* isolate = context->GetIsolate();\n\n // Create a new instance of `AddonData` for this instance of the addon and\n // tie its life cycle to that of the Node.js environment.\n AddonData* data = new AddonData(isolate);\n\n // Wrap the data in a `v8::External` so we can pass it to the method we\n // expose.\n Local<External> external = External::New(isolate, data);\n\n // Expose the method `Method` to JavaScript, and make sure it receives the\n // per-addon-instance data we created above by passing `external` as the\n // third parameter to the `FunctionTemplate` constructor.\n exports->Set(context,\n String::NewFromUtf8(isolate, \"method\", NewStringType::kNormal)\n .ToLocalChecked(),\n FunctionTemplate::New(isolate, Method, external)\n ->GetFunction(context).ToLocalChecked()).FromJust();\n}\n</code></pre>",
|
|
"modules": [
|
|
{
|
|
"textRaw": "Worker support",
|
|
"name": "worker_support",
|
|
"desc": "<p>In order to be loaded from multiple Node.js environments,\nsuch as a main thread and a Worker thread, an add-on needs to either:</p>\n<ul>\n<li>Be an N-API addon, or</li>\n<li>Be declared as context-aware using <code>NODE_MODULE_INIT()</code> as described above</li>\n</ul>\n<p>In order to support <a href=\"worker_threads.html#worker_threads_class_worker\"><code>Worker</code></a> threads, addons need to clean up any resources\nthey may have allocated when such a thread exists. This can be achieved through\nthe usage of the <code>AddEnvironmentCleanupHook()</code> function:</p>\n<pre><code class=\"language-c++\">void AddEnvironmentCleanupHook(v8::Isolate* isolate,\n void (*fun)(void* arg),\n void* arg);\n</code></pre>\n<p>This function adds a hook that will run before a given Node.js instance shuts\ndown. If necessary, such hooks can be removed using\n<code>RemoveEnvironmentCleanupHook()</code> before they are run, which has the same\nsignature. Callbacks are run in last-in first-out order.</p>\n<p>The following <code>addon.cc</code> uses <code>AddEnvironmentCleanupHook</code>:</p>\n<pre><code class=\"language-cpp\">// addon.cc\n#include <assert.h>\n#include <stdlib.h>\n#include <node.h>\n\nusing node::AddEnvironmentCleanupHook;\nusing v8::HandleScope;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Object;\n\n// Note: In a real-world application, do not rely on static/global data.\nstatic char cookie[] = \"yum yum\";\nstatic int cleanup_cb1_called = 0;\nstatic int cleanup_cb2_called = 0;\n\nstatic void cleanup_cb1(void* arg) {\n Isolate* isolate = static_cast<Isolate*>(arg);\n HandleScope scope(isolate);\n Local<Object> obj = Object::New(isolate);\n assert(!obj.IsEmpty()); // assert VM is still alive\n assert(obj->IsObject());\n cleanup_cb1_called++;\n}\n\nstatic void cleanup_cb2(void* arg) {\n assert(arg == static_cast<void*>(cookie));\n cleanup_cb2_called++;\n}\n\nstatic void sanity_check(void*) {\n assert(cleanup_cb1_called == 1);\n assert(cleanup_cb2_called == 1);\n}\n\n// Initialize this addon to be context-aware.\nNODE_MODULE_INIT(/* exports, module, context */) {\n Isolate* isolate = context->GetIsolate();\n\n AddEnvironmentCleanupHook(isolate, sanity_check, nullptr);\n AddEnvironmentCleanupHook(isolate, cleanup_cb2, cookie);\n AddEnvironmentCleanupHook(isolate, cleanup_cb1, isolate);\n}\n</code></pre>\n<p>Test in JavaScript by running:</p>\n<pre><code class=\"language-js\">// test.js\nrequire('./build/Release/addon');\n</code></pre>",
|
|
"type": "module",
|
|
"displayName": "Worker support"
|
|
}
|
|
],
|
|
"type": "module",
|
|
"displayName": "Context-aware addons"
|
|
},
|
|
{
|
|
"textRaw": "Building",
|
|
"name": "building",
|
|
"desc": "<p>Once the source code has been written, it must be compiled into the binary\n<code>addon.node</code> file. To do so, create a file called <code>binding.gyp</code> in the\ntop-level of the project describing the build configuration of the module\nusing a JSON-like format. This file is used by <a href=\"https://github.com/nodejs/node-gyp\">node-gyp</a>, a tool written\nspecifically to compile Node.js Addons.</p>\n<pre><code class=\"language-json\">{\n \"targets\": [\n {\n \"target_name\": \"addon\",\n \"sources\": [ \"hello.cc\" ]\n }\n ]\n}\n</code></pre>\n<p>A version of the <code>node-gyp</code> utility is bundled and distributed with\nNode.js as part of <code>npm</code>. This version is not made directly available for\ndevelopers to use and is intended only to support the ability to use the\n<code>npm install</code> command to compile and install Addons. Developers who wish to\nuse <code>node-gyp</code> directly can install it using the command\n<code>npm install -g node-gyp</code>. See the <code>node-gyp</code> <a href=\"https://github.com/nodejs/node-gyp#installation\">installation instructions</a> for\nmore information, including platform-specific requirements.</p>\n<p>Once the <code>binding.gyp</code> file has been created, use <code>node-gyp configure</code> to\ngenerate the appropriate project build files for the current platform. This\nwill generate either a <code>Makefile</code> (on Unix platforms) or a <code>vcxproj</code> file\n(on Windows) in the <code>build/</code> directory.</p>\n<p>Next, invoke the <code>node-gyp build</code> command to generate the compiled <code>addon.node</code>\nfile. This will be put into the <code>build/Release/</code> directory.</p>\n<p>When using <code>npm install</code> to install a Node.js Addon, npm uses its own bundled\nversion of <code>node-gyp</code> to perform this same set of actions, generating a\ncompiled version of the Addon for the user's platform on demand.</p>\n<p>Once built, the binary Addon can be used from within Node.js by pointing\n<a href=\"modules.html#modules_require_id\"><code>require()</code></a> to the built <code>addon.node</code> module:</p>\n<pre><code class=\"language-js\">// hello.js\nconst addon = require('./build/Release/addon');\n\nconsole.log(addon.hello());\n// Prints: 'world'\n</code></pre>\n<p>Because the exact path to the compiled Addon binary can vary depending on how\nit is compiled (i.e. sometimes it may be in <code>./build/Debug/</code>), Addons can use\nthe <a href=\"https://github.com/TooTallNate/node-bindings\">bindings</a> package to load the compiled module.</p>\n<p>While the <code>bindings</code> package implementation is more sophisticated in how it\nlocates Addon modules, it is essentially using a <code>try…catch</code> pattern similar to:</p>\n<pre><code class=\"language-js\">try {\n return require('./build/Release/addon.node');\n} catch (err) {\n return require('./build/Debug/addon.node');\n}\n</code></pre>",
|
|
"type": "module",
|
|
"displayName": "Building"
|
|
},
|
|
{
|
|
"textRaw": "Linking to libraries included with Node.js",
|
|
"name": "linking_to_libraries_included_with_node.js",
|
|
"desc": "<p>Node.js uses statically linked libraries such as V8, libuv and OpenSSL. All\nAddons are required to link to V8 and may link to any of the other dependencies\nas well. Typically, this is as simple as including the appropriate\n<code>#include <...></code> statements (e.g. <code>#include <v8.h></code>) and <code>node-gyp</code> will locate\nthe appropriate headers automatically. However, there are a few caveats to be\naware of:</p>\n<ul>\n<li>\n<p>When <code>node-gyp</code> runs, it will detect the specific release version of Node.js\nand download either the full source tarball or just the headers. If the full\nsource is downloaded, Addons will have complete access to the full set of\nNode.js dependencies. However, if only the Node.js headers are downloaded, then\nonly the symbols exported by Node.js will be available.</p>\n</li>\n<li>\n<p><code>node-gyp</code> can be run using the <code>--nodedir</code> flag pointing at a local Node.js\nsource image. Using this option, the Addon will have access to the full set of\ndependencies.</p>\n</li>\n</ul>",
|
|
"type": "module",
|
|
"displayName": "Linking to libraries included with Node.js"
|
|
},
|
|
{
|
|
"textRaw": "Loading Addons using `require()`",
|
|
"name": "loading_addons_using_`require()`",
|
|
"desc": "<p>The filename extension of the compiled Addon binary is <code>.node</code> (as opposed\nto <code>.dll</code> or <code>.so</code>). The <a href=\"modules.html#modules_require_id\"><code>require()</code></a> function is written to look for\nfiles with the <code>.node</code> file extension and initialize those as dynamically-linked\nlibraries.</p>\n<p>When calling <a href=\"modules.html#modules_require_id\"><code>require()</code></a>, the <code>.node</code> extension can usually be\nomitted and Node.js will still find and initialize the Addon. One caveat,\nhowever, is that Node.js will first attempt to locate and load modules or\nJavaScript files that happen to share the same base name. For instance, if\nthere is a file <code>addon.js</code> in the same directory as the binary <code>addon.node</code>,\nthen <a href=\"modules.html#modules_require_id\"><code>require('addon')</code></a> will give precedence to the <code>addon.js</code> file\nand load it instead.</p>",
|
|
"type": "module",
|
|
"displayName": "Loading Addons using `require()`"
|
|
}
|
|
],
|
|
"type": "misc",
|
|
"displayName": "Hello world"
|
|
},
|
|
{
|
|
"textRaw": "Native Abstractions for Node.js",
|
|
"name": "native_abstractions_for_node.js",
|
|
"desc": "<p>Each of the examples illustrated in this document make direct use of the\nNode.js and V8 APIs for implementing Addons. The V8 API can, and has, changed\ndramatically from one V8 release to the next (and one major Node.js release to\nthe next). With each change, Addons may need to be updated and recompiled in\norder to continue functioning. The Node.js release schedule is designed to\nminimize the frequency and impact of such changes but there is little that\nNode.js can do currently to ensure stability of the V8 APIs.</p>\n<p>The <a href=\"https://github.com/nodejs/nan\">Native Abstractions for Node.js</a> (or <code>nan</code>) provide a set of tools that\nAddon developers are recommended to use to keep compatibility between past and\nfuture releases of V8 and Node.js. See the <code>nan</code> <a href=\"https://github.com/nodejs/nan/tree/master/examples/\">examples</a> for an\nillustration of how it can be used.</p>",
|
|
"type": "misc",
|
|
"displayName": "Native Abstractions for Node.js"
|
|
},
|
|
{
|
|
"textRaw": "N-API",
|
|
"name": "n-api",
|
|
"stability": 2,
|
|
"stabilityText": "Stable",
|
|
"desc": "<p>N-API is an API for building native Addons. It is independent from\nthe underlying JavaScript runtime (e.g. V8) and is maintained as part of\nNode.js itself. This API will be Application Binary Interface (ABI) stable\nacross versions of Node.js. It is intended to insulate Addons from\nchanges in the underlying JavaScript engine and allow modules\ncompiled for one version to run on later versions of Node.js without\nrecompilation. Addons are built/packaged with the same approach/tools\noutlined in this document (node-gyp, etc.). The only difference is the\nset of APIs that are used by the native code. Instead of using the V8\nor <a href=\"https://github.com/nodejs/nan\">Native Abstractions for Node.js</a> APIs, the functions available\nin the N-API are used.</p>\n<p>Creating and maintaining an addon that benefits from the ABI stability\nprovided by N-API carries with it certain\n<a href=\"n-api.html#n_api_implications_of_abi_stability\">implementation considerations</a>.</p>\n<p>To use N-API in the above \"Hello world\" example, replace the content of\n<code>hello.cc</code> with the following. All other instructions remain the same.</p>\n<pre><code class=\"language-cpp\">// hello.cc using N-API\n#include <node_api.h>\n\nnamespace demo {\n\nnapi_value Method(napi_env env, napi_callback_info args) {\n napi_value greeting;\n napi_status status;\n\n status = napi_create_string_utf8(env, \"world\", NAPI_AUTO_LENGTH, &greeting);\n if (status != napi_ok) return nullptr;\n return greeting;\n}\n\nnapi_value init(napi_env env, napi_value exports) {\n napi_status status;\n napi_value fn;\n\n status = napi_create_function(env, nullptr, 0, Method, nullptr, &fn);\n if (status != napi_ok) return nullptr;\n\n status = napi_set_named_property(env, exports, \"hello\", fn);\n if (status != napi_ok) return nullptr;\n return exports;\n}\n\nNAPI_MODULE(NODE_GYP_MODULE_NAME, init)\n\n} // namespace demo\n</code></pre>\n<p>The functions available and how to use them are documented in\n<a href=\"n-api.html\">C/C++ Addons with N-API</a>.</p>",
|
|
"type": "misc",
|
|
"displayName": "N-API"
|
|
},
|
|
{
|
|
"textRaw": "Addon examples",
|
|
"name": "addon_examples",
|
|
"desc": "<p>Following are some example Addons intended to help developers get started. The\nexamples make use of the V8 APIs. Refer to the online <a href=\"https://v8docs.nodesource.com/\">V8 reference</a>\nfor help with the various V8 calls, and V8's <a href=\"https://github.com/v8/v8/wiki/Embedder's%20Guide\">Embedder's Guide</a> for an\nexplanation of several concepts used such as handles, scopes, function\ntemplates, etc.</p>\n<p>Each of these examples using the following <code>binding.gyp</code> file:</p>\n<pre><code class=\"language-json\">{\n \"targets\": [\n {\n \"target_name\": \"addon\",\n \"sources\": [ \"addon.cc\" ]\n }\n ]\n}\n</code></pre>\n<p>In cases where there is more than one <code>.cc</code> file, simply add the additional\nfilename to the <code>sources</code> array:</p>\n<pre><code class=\"language-json\">\"sources\": [\"addon.cc\", \"myexample.cc\"]\n</code></pre>\n<p>Once the <code>binding.gyp</code> file is ready, the example Addons can be configured and\nbuilt using <code>node-gyp</code>:</p>\n<pre><code class=\"language-console\">$ node-gyp configure build\n</code></pre>",
|
|
"modules": [
|
|
{
|
|
"textRaw": "Function arguments",
|
|
"name": "function_arguments",
|
|
"desc": "<p>Addons will typically expose objects and functions that can be accessed from\nJavaScript running within Node.js. When functions are invoked from JavaScript,\nthe input arguments and return value must be mapped to and from the C/C++\ncode.</p>\n<p>The following example illustrates how to read function arguments passed from\nJavaScript and how to return a result:</p>\n<pre><code class=\"language-cpp\">// addon.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::Exception;\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::NewStringType;\nusing v8::Number;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\n// This is the implementation of the \"add\" method\n// Input arguments are passed using the\n// const FunctionCallbackInfo<Value>& args struct\nvoid Add(const FunctionCallbackInfo<Value>& args) {\n Isolate* isolate = args.GetIsolate();\n\n // Check the number of arguments passed.\n if (args.Length() < 2) {\n // Throw an Error that is passed back to JavaScript\n isolate->ThrowException(Exception::TypeError(\n String::NewFromUtf8(isolate,\n \"Wrong number of arguments\",\n NewStringType::kNormal).ToLocalChecked()));\n return;\n }\n\n // Check the argument types\n if (!args[0]->IsNumber() || !args[1]->IsNumber()) {\n isolate->ThrowException(Exception::TypeError(\n String::NewFromUtf8(isolate,\n \"Wrong arguments\",\n NewStringType::kNormal).ToLocalChecked()));\n return;\n }\n\n // Perform the operation\n double value =\n args[0].As<Number>()->Value() + args[1].As<Number>()->Value();\n Local<Number> num = Number::New(isolate, value);\n\n // Set the return value (using the passed in\n // FunctionCallbackInfo<Value>&)\n args.GetReturnValue().Set(num);\n}\n\nvoid Init(Local<Object> exports) {\n NODE_SET_METHOD(exports, \"add\", Add);\n}\n\nNODE_MODULE(NODE_GYP_MODULE_NAME, Init)\n\n} // namespace demo\n</code></pre>\n<p>Once compiled, the example Addon can be required and used from within Node.js:</p>\n<pre><code class=\"language-js\">// test.js\nconst addon = require('./build/Release/addon');\n\nconsole.log('This should be eight:', addon.add(3, 5));\n</code></pre>",
|
|
"type": "module",
|
|
"displayName": "Function arguments"
|
|
},
|
|
{
|
|
"textRaw": "Callbacks",
|
|
"name": "callbacks",
|
|
"desc": "<p>It is common practice within Addons to pass JavaScript functions to a C++\nfunction and execute them from there. The following example illustrates how\nto invoke such callbacks:</p>\n<pre><code class=\"language-cpp\">// addon.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::Context;\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::NewStringType;\nusing v8::Null;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid RunCallback(const FunctionCallbackInfo<Value>& args) {\n Isolate* isolate = args.GetIsolate();\n Local<Context> context = isolate->GetCurrentContext();\n Local<Function> cb = Local<Function>::Cast(args[0]);\n const unsigned argc = 1;\n Local<Value> argv[argc] = {\n String::NewFromUtf8(isolate,\n \"hello world\",\n NewStringType::kNormal).ToLocalChecked() };\n cb->Call(context, Null(isolate), argc, argv).ToLocalChecked();\n}\n\nvoid Init(Local<Object> exports, Local<Object> module) {\n NODE_SET_METHOD(module, \"exports\", RunCallback);\n}\n\nNODE_MODULE(NODE_GYP_MODULE_NAME, Init)\n\n} // namespace demo\n</code></pre>\n<p>This example uses a two-argument form of <code>Init()</code> that receives the full\n<code>module</code> object as the second argument. This allows the Addon to completely\noverwrite <code>exports</code> with a single function instead of adding the function as a\nproperty of <code>exports</code>.</p>\n<p>To test it, run the following JavaScript:</p>\n<pre><code class=\"language-js\">// test.js\nconst addon = require('./build/Release/addon');\n\naddon((msg) => {\n console.log(msg);\n// Prints: 'hello world'\n});\n</code></pre>\n<p>In this example, the callback function is invoked synchronously.</p>",
|
|
"type": "module",
|
|
"displayName": "Callbacks"
|
|
},
|
|
{
|
|
"textRaw": "Object factory",
|
|
"name": "object_factory",
|
|
"desc": "<p>Addons can create and return new objects from within a C++ function as\nillustrated in the following example. An object is created and returned with a\nproperty <code>msg</code> that echoes the string passed to <code>createObject()</code>:</p>\n<pre><code class=\"language-cpp\">// addon.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::Context;\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::NewStringType;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid CreateObject(const FunctionCallbackInfo<Value>& args) {\n Isolate* isolate = args.GetIsolate();\n Local<Context> context = isolate->GetCurrentContext();\n\n Local<Object> obj = Object::New(isolate);\n obj->Set(context,\n String::NewFromUtf8(isolate,\n \"msg\",\n NewStringType::kNormal).ToLocalChecked(),\n args[0]->ToString(context).ToLocalChecked())\n .FromJust();\n\n args.GetReturnValue().Set(obj);\n}\n\nvoid Init(Local<Object> exports, Local<Object> module) {\n NODE_SET_METHOD(module, \"exports\", CreateObject);\n}\n\nNODE_MODULE(NODE_GYP_MODULE_NAME, Init)\n\n} // namespace demo\n</code></pre>\n<p>To test it in JavaScript:</p>\n<pre><code class=\"language-js\">// test.js\nconst addon = require('./build/Release/addon');\n\nconst obj1 = addon('hello');\nconst obj2 = addon('world');\nconsole.log(obj1.msg, obj2.msg);\n// Prints: 'hello world'\n</code></pre>",
|
|
"type": "module",
|
|
"displayName": "Object factory"
|
|
},
|
|
{
|
|
"textRaw": "Function factory",
|
|
"name": "function_factory",
|
|
"desc": "<p>Another common scenario is creating JavaScript functions that wrap C++\nfunctions and returning those back to JavaScript:</p>\n<pre><code class=\"language-cpp\">// addon.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::Context;\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::FunctionTemplate;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::NewStringType;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid MyFunction(const FunctionCallbackInfo<Value>& args) {\n Isolate* isolate = args.GetIsolate();\n args.GetReturnValue().Set(String::NewFromUtf8(\n isolate, \"hello world\", NewStringType::kNormal).ToLocalChecked());\n}\n\nvoid CreateFunction(const FunctionCallbackInfo<Value>& args) {\n Isolate* isolate = args.GetIsolate();\n\n Local<Context> context = isolate->GetCurrentContext();\n Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, MyFunction);\n Local<Function> fn = tpl->GetFunction(context).ToLocalChecked();\n\n // omit this to make it anonymous\n fn->SetName(String::NewFromUtf8(\n isolate, \"theFunction\", NewStringType::kNormal).ToLocalChecked());\n\n args.GetReturnValue().Set(fn);\n}\n\nvoid Init(Local<Object> exports, Local<Object> module) {\n NODE_SET_METHOD(module, \"exports\", CreateFunction);\n}\n\nNODE_MODULE(NODE_GYP_MODULE_NAME, Init)\n\n} // namespace demo\n</code></pre>\n<p>To test:</p>\n<pre><code class=\"language-js\">// test.js\nconst addon = require('./build/Release/addon');\n\nconst fn = addon();\nconsole.log(fn());\n// Prints: 'hello world'\n</code></pre>",
|
|
"type": "module",
|
|
"displayName": "Function factory"
|
|
},
|
|
{
|
|
"textRaw": "Wrapping C++ objects",
|
|
"name": "wrapping_c++_objects",
|
|
"desc": "<p>It is also possible to wrap C++ objects/classes in a way that allows new\ninstances to be created using the JavaScript <code>new</code> operator:</p>\n<pre><code class=\"language-cpp\">// addon.cc\n#include <node.h>\n#include \"myobject.h\"\n\nnamespace demo {\n\nusing v8::Local;\nusing v8::Object;\n\nvoid InitAll(Local<Object> exports) {\n MyObject::Init(exports);\n}\n\nNODE_MODULE(NODE_GYP_MODULE_NAME, InitAll)\n\n} // namespace demo\n</code></pre>\n<p>Then, in <code>myobject.h</code>, the wrapper class inherits from <code>node::ObjectWrap</code>:</p>\n<pre><code class=\"language-cpp\">// myobject.h\n#ifndef MYOBJECT_H\n#define MYOBJECT_H\n\n#include <node.h>\n#include <node_object_wrap.h>\n\nnamespace demo {\n\nclass MyObject : public node::ObjectWrap {\n public:\n static void Init(v8::Local<v8::Object> exports);\n\n private:\n explicit MyObject(double value = 0);\n ~MyObject();\n\n static void New(const v8::FunctionCallbackInfo<v8::Value>& args);\n static void PlusOne(const v8::FunctionCallbackInfo<v8::Value>& args);\n\n double value_;\n};\n\n} // namespace demo\n\n#endif\n</code></pre>\n<p>In <code>myobject.cc</code>, implement the various methods that are to be exposed.\nBelow, the method <code>plusOne()</code> is exposed by adding it to the constructor's\nprototype:</p>\n<pre><code class=\"language-cpp\">// myobject.cc\n#include \"myobject.h\"\n\nnamespace demo {\n\nusing v8::Context;\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::FunctionTemplate;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::NewStringType;\nusing v8::Number;\nusing v8::Object;\nusing v8::ObjectTemplate;\nusing v8::String;\nusing v8::Value;\n\nMyObject::MyObject(double value) : value_(value) {\n}\n\nMyObject::~MyObject() {\n}\n\nvoid MyObject::Init(Local<Object> exports) {\n Isolate* isolate = exports->GetIsolate();\n Local<Context> context = isolate->GetCurrentContext();\n\n Local<ObjectTemplate> addon_data_tpl = ObjectTemplate::New(isolate);\n addon_data_tpl->SetInternalFieldCount(1); // 1 field for the MyObject::New()\n Local<Object> addon_data =\n addon_data_tpl->NewInstance(context).ToLocalChecked();\n\n // Prepare constructor template\n Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New, addon_data);\n tpl->SetClassName(String::NewFromUtf8(\n isolate, \"MyObject\", NewStringType::kNormal).ToLocalChecked());\n tpl->InstanceTemplate()->SetInternalFieldCount(1);\n\n // Prototype\n NODE_SET_PROTOTYPE_METHOD(tpl, \"plusOne\", PlusOne);\n\n Local<Function> constructor = tpl->GetFunction(context).ToLocalChecked();\n addon_data->SetInternalField(0, constructor);\n exports->Set(context, String::NewFromUtf8(\n isolate, \"MyObject\", NewStringType::kNormal).ToLocalChecked(),\n constructor).FromJust();\n}\n\nvoid MyObject::New(const FunctionCallbackInfo<Value>& args) {\n Isolate* isolate = args.GetIsolate();\n Local<Context> context = isolate->GetCurrentContext();\n\n if (args.IsConstructCall()) {\n // Invoked as constructor: `new MyObject(...)`\n double value = args[0]->IsUndefined() ?\n 0 : args[0]->NumberValue(context).FromMaybe(0);\n MyObject* obj = new MyObject(value);\n obj->Wrap(args.This());\n args.GetReturnValue().Set(args.This());\n } else {\n // Invoked as plain function `MyObject(...)`, turn into construct call.\n const int argc = 1;\n Local<Value> argv[argc] = { args[0] };\n Local<Function> cons =\n args.Data().As<Object>()->GetInternalField(0).As<Function>();\n Local<Object> result =\n cons->NewInstance(context, argc, argv).ToLocalChecked();\n args.GetReturnValue().Set(result);\n }\n}\n\nvoid MyObject::PlusOne(const FunctionCallbackInfo<Value>& args) {\n Isolate* isolate = args.GetIsolate();\n\n MyObject* obj = ObjectWrap::Unwrap<MyObject>(args.Holder());\n obj->value_ += 1;\n\n args.GetReturnValue().Set(Number::New(isolate, obj->value_));\n}\n\n} // namespace demo\n</code></pre>\n<p>To build this example, the <code>myobject.cc</code> file must be added to the\n<code>binding.gyp</code>:</p>\n<pre><code class=\"language-json\">{\n \"targets\": [\n {\n \"target_name\": \"addon\",\n \"sources\": [\n \"addon.cc\",\n \"myobject.cc\"\n ]\n }\n ]\n}\n</code></pre>\n<p>Test it with:</p>\n<pre><code class=\"language-js\">// test.js\nconst addon = require('./build/Release/addon');\n\nconst obj = new addon.MyObject(10);\nconsole.log(obj.plusOne());\n// Prints: 11\nconsole.log(obj.plusOne());\n// Prints: 12\nconsole.log(obj.plusOne());\n// Prints: 13\n</code></pre>\n<p>The destructor for a wrapper object will run when the object is\ngarbage-collected. For destructor testing, there are command-line flags that\ncan be used to make it possible to force garbage collection. These flags are\nprovided by the underlying V8 JavaScript engine. They are subject to change\nor removal at any time. They are not documented by Node.js or V8, and they\nshould never be used outside of testing.</p>",
|
|
"type": "module",
|
|
"displayName": "Wrapping C++ objects"
|
|
},
|
|
{
|
|
"textRaw": "Factory of wrapped objects",
|
|
"name": "factory_of_wrapped_objects",
|
|
"desc": "<p>Alternatively, it is possible to use a factory pattern to avoid explicitly\ncreating object instances using the JavaScript <code>new</code> operator:</p>\n<pre><code class=\"language-js\">const obj = addon.createObject();\n// instead of:\n// const obj = new addon.Object();\n</code></pre>\n<p>First, the <code>createObject()</code> method is implemented in <code>addon.cc</code>:</p>\n<pre><code class=\"language-cpp\">// addon.cc\n#include <node.h>\n#include \"myobject.h\"\n\nnamespace demo {\n\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid CreateObject(const FunctionCallbackInfo<Value>& args) {\n MyObject::NewInstance(args);\n}\n\nvoid InitAll(Local<Object> exports, Local<Object> module) {\n MyObject::Init(exports->GetIsolate());\n\n NODE_SET_METHOD(module, \"exports\", CreateObject);\n}\n\nNODE_MODULE(NODE_GYP_MODULE_NAME, InitAll)\n\n} // namespace demo\n</code></pre>\n<p>In <code>myobject.h</code>, the static method <code>NewInstance()</code> is added to handle\ninstantiating the object. This method takes the place of using <code>new</code> in\nJavaScript:</p>\n<pre><code class=\"language-cpp\">// myobject.h\n#ifndef MYOBJECT_H\n#define MYOBJECT_H\n\n#include <node.h>\n#include <node_object_wrap.h>\n\nnamespace demo {\n\nclass MyObject : public node::ObjectWrap {\n public:\n static void Init(v8::Isolate* isolate);\n static void NewInstance(const v8::FunctionCallbackInfo<v8::Value>& args);\n\n private:\n explicit MyObject(double value = 0);\n ~MyObject();\n\n static void New(const v8::FunctionCallbackInfo<v8::Value>& args);\n static void PlusOne(const v8::FunctionCallbackInfo<v8::Value>& args);\n static v8::Global<v8::Function> constructor;\n double value_;\n};\n\n} // namespace demo\n\n#endif\n</code></pre>\n<p>The implementation in <code>myobject.cc</code> is similar to the previous example:</p>\n<pre><code class=\"language-cpp\">// myobject.cc\n#include <node.h>\n#include \"myobject.h\"\n\nnamespace demo {\n\nusing node::AddEnvironmentCleanupHook;\nusing v8::Context;\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::FunctionTemplate;\nusing v8::Global;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::NewStringType;\nusing v8::Number;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\n// Warning! This is not thread-safe, this addon cannot be used for worker\n// threads.\nGlobal<Function> MyObject::constructor;\n\nMyObject::MyObject(double value) : value_(value) {\n}\n\nMyObject::~MyObject() {\n}\n\nvoid MyObject::Init(Isolate* isolate) {\n // Prepare constructor template\n Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);\n tpl->SetClassName(String::NewFromUtf8(\n isolate, \"MyObject\", NewStringType::kNormal).ToLocalChecked());\n tpl->InstanceTemplate()->SetInternalFieldCount(1);\n\n // Prototype\n NODE_SET_PROTOTYPE_METHOD(tpl, \"plusOne\", PlusOne);\n\n Local<Context> context = isolate->GetCurrentContext();\n constructor.Reset(isolate, tpl->GetFunction(context).ToLocalChecked());\n\n AddEnvironmentCleanupHook(isolate, [](void*) {\n constructor.Reset();\n }, nullptr);\n}\n\nvoid MyObject::New(const FunctionCallbackInfo<Value>& args) {\n Isolate* isolate = args.GetIsolate();\n Local<Context> context = isolate->GetCurrentContext();\n\n if (args.IsConstructCall()) {\n // Invoked as constructor: `new MyObject(...)`\n double value = args[0]->IsUndefined() ?\n 0 : args[0]->NumberValue(context).FromMaybe(0);\n MyObject* obj = new MyObject(value);\n obj->Wrap(args.This());\n args.GetReturnValue().Set(args.This());\n } else {\n // Invoked as plain function `MyObject(...)`, turn into construct call.\n const int argc = 1;\n Local<Value> argv[argc] = { args[0] };\n Local<Function> cons = Local<Function>::New(isolate, constructor);\n Local<Object> instance =\n cons->NewInstance(context, argc, argv).ToLocalChecked();\n args.GetReturnValue().Set(instance);\n }\n}\n\nvoid MyObject::NewInstance(const FunctionCallbackInfo<Value>& args) {\n Isolate* isolate = args.GetIsolate();\n\n const unsigned argc = 1;\n Local<Value> argv[argc] = { args[0] };\n Local<Function> cons = Local<Function>::New(isolate, constructor);\n Local<Context> context = isolate->GetCurrentContext();\n Local<Object> instance =\n cons->NewInstance(context, argc, argv).ToLocalChecked();\n\n args.GetReturnValue().Set(instance);\n}\n\nvoid MyObject::PlusOne(const FunctionCallbackInfo<Value>& args) {\n Isolate* isolate = args.GetIsolate();\n\n MyObject* obj = ObjectWrap::Unwrap<MyObject>(args.Holder());\n obj->value_ += 1;\n\n args.GetReturnValue().Set(Number::New(isolate, obj->value_));\n}\n\n} // namespace demo\n</code></pre>\n<p>Once again, to build this example, the <code>myobject.cc</code> file must be added to the\n<code>binding.gyp</code>:</p>\n<pre><code class=\"language-json\">{\n \"targets\": [\n {\n \"target_name\": \"addon\",\n \"sources\": [\n \"addon.cc\",\n \"myobject.cc\"\n ]\n }\n ]\n}\n</code></pre>\n<p>Test it with:</p>\n<pre><code class=\"language-js\">// test.js\nconst createObject = require('./build/Release/addon');\n\nconst obj = createObject(10);\nconsole.log(obj.plusOne());\n// Prints: 11\nconsole.log(obj.plusOne());\n// Prints: 12\nconsole.log(obj.plusOne());\n// Prints: 13\n\nconst obj2 = createObject(20);\nconsole.log(obj2.plusOne());\n// Prints: 21\nconsole.log(obj2.plusOne());\n// Prints: 22\nconsole.log(obj2.plusOne());\n// Prints: 23\n</code></pre>",
|
|
"type": "module",
|
|
"displayName": "Factory of wrapped objects"
|
|
},
|
|
{
|
|
"textRaw": "Passing wrapped objects around",
|
|
"name": "passing_wrapped_objects_around",
|
|
"desc": "<p>In addition to wrapping and returning C++ objects, it is possible to pass\nwrapped objects around by unwrapping them with the Node.js helper function\n<code>node::ObjectWrap::Unwrap</code>. The following examples shows a function <code>add()</code>\nthat can take two <code>MyObject</code> objects as input arguments:</p>\n<pre><code class=\"language-cpp\">// addon.cc\n#include <node.h>\n#include <node_object_wrap.h>\n#include \"myobject.h\"\n\nnamespace demo {\n\nusing v8::Context;\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Number;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid CreateObject(const FunctionCallbackInfo<Value>& args) {\n MyObject::NewInstance(args);\n}\n\nvoid Add(const FunctionCallbackInfo<Value>& args) {\n Isolate* isolate = args.GetIsolate();\n Local<Context> context = isolate->GetCurrentContext();\n\n MyObject* obj1 = node::ObjectWrap::Unwrap<MyObject>(\n args[0]->ToObject(context).ToLocalChecked());\n MyObject* obj2 = node::ObjectWrap::Unwrap<MyObject>(\n args[1]->ToObject(context).ToLocalChecked());\n\n double sum = obj1->value() + obj2->value();\n args.GetReturnValue().Set(Number::New(isolate, sum));\n}\n\nvoid InitAll(Local<Object> exports) {\n MyObject::Init(exports->GetIsolate());\n\n NODE_SET_METHOD(exports, \"createObject\", CreateObject);\n NODE_SET_METHOD(exports, \"add\", Add);\n}\n\nNODE_MODULE(NODE_GYP_MODULE_NAME, InitAll)\n\n} // namespace demo\n</code></pre>\n<p>In <code>myobject.h</code>, a new public method is added to allow access to private values\nafter unwrapping the object.</p>\n<pre><code class=\"language-cpp\">// myobject.h\n#ifndef MYOBJECT_H\n#define MYOBJECT_H\n\n#include <node.h>\n#include <node_object_wrap.h>\n\nnamespace demo {\n\nclass MyObject : public node::ObjectWrap {\n public:\n static void Init(v8::Isolate* isolate);\n static void NewInstance(const v8::FunctionCallbackInfo<v8::Value>& args);\n inline double value() const { return value_; }\n\n private:\n explicit MyObject(double value = 0);\n ~MyObject();\n\n static void New(const v8::FunctionCallbackInfo<v8::Value>& args);\n static v8::Global<v8::Function> constructor;\n double value_;\n};\n\n} // namespace demo\n\n#endif\n</code></pre>\n<p>The implementation of <code>myobject.cc</code> is similar to before:</p>\n<pre><code class=\"language-cpp\">// myobject.cc\n#include <node.h>\n#include \"myobject.h\"\n\nnamespace demo {\n\nusing node::AddEnvironmentCleanupHook;\nusing v8::Context;\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::FunctionTemplate;\nusing v8::Global;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::NewStringType;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\n// Warning! This is not thread-safe, this addon cannot be used for worker\n// threads.\nGlobal<Function> MyObject::constructor;\n\nMyObject::MyObject(double value) : value_(value) {\n}\n\nMyObject::~MyObject() {\n}\n\nvoid MyObject::Init(Isolate* isolate) {\n // Prepare constructor template\n Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);\n tpl->SetClassName(String::NewFromUtf8(\n isolate, \"MyObject\", NewStringType::kNormal).ToLocalChecked());\n tpl->InstanceTemplate()->SetInternalFieldCount(1);\n\n Local<Context> context = isolate->GetCurrentContext();\n constructor.Reset(isolate, tpl->GetFunction(context).ToLocalChecked());\n\n AddEnvironmentCleanupHook(isolate, [](void*) {\n constructor.Reset();\n }, nullptr);\n}\n\nvoid MyObject::New(const FunctionCallbackInfo<Value>& args) {\n Isolate* isolate = args.GetIsolate();\n Local<Context> context = isolate->GetCurrentContext();\n\n if (args.IsConstructCall()) {\n // Invoked as constructor: `new MyObject(...)`\n double value = args[0]->IsUndefined() ?\n 0 : args[0]->NumberValue(context).FromMaybe(0);\n MyObject* obj = new MyObject(value);\n obj->Wrap(args.This());\n args.GetReturnValue().Set(args.This());\n } else {\n // Invoked as plain function `MyObject(...)`, turn into construct call.\n const int argc = 1;\n Local<Value> argv[argc] = { args[0] };\n Local<Function> cons = Local<Function>::New(isolate, constructor);\n Local<Object> instance =\n cons->NewInstance(context, argc, argv).ToLocalChecked();\n args.GetReturnValue().Set(instance);\n }\n}\n\nvoid MyObject::NewInstance(const FunctionCallbackInfo<Value>& args) {\n Isolate* isolate = args.GetIsolate();\n\n const unsigned argc = 1;\n Local<Value> argv[argc] = { args[0] };\n Local<Function> cons = Local<Function>::New(isolate, constructor);\n Local<Context> context = isolate->GetCurrentContext();\n Local<Object> instance =\n cons->NewInstance(context, argc, argv).ToLocalChecked();\n\n args.GetReturnValue().Set(instance);\n}\n\n} // namespace demo\n</code></pre>\n<p>Test it with:</p>\n<pre><code class=\"language-js\">// test.js\nconst addon = require('./build/Release/addon');\n\nconst obj1 = addon.createObject(10);\nconst obj2 = addon.createObject(20);\nconst result = addon.add(obj1, obj2);\n\nconsole.log(result);\n// Prints: 30\n</code></pre>",
|
|
"type": "module",
|
|
"displayName": "Passing wrapped objects around"
|
|
}
|
|
],
|
|
"type": "misc",
|
|
"displayName": "Addon examples"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
} |