node-addon-api 2.0.2 → 3.1.0

package/README.md

@@ -4,6 +4,14 @@ the use of the C based [N-API](https://nodejs.org/dist/latest/docs/api/n-api.htm
 provided by Node.js when using C++. It provides a C++ object model
 and exception handling semantics with low overhead.
 
+There are three options for implementing addons: N-API, nan, or direct
+use of internal V8, libuv and Node.js libraries. Unless there is a need for
+direct access to functionality which is not exposed by N-API as outlined
+in [C/C++ addons](https://nodejs.org/dist/latest/docs/api/addons.html)
+in Node.js core, use N-API. Refer to
+[C/C++ addons with N-API](https://nodejs.org/dist/latest/docs/api/n-api.html)
+for more information on N-API.
+
 N-API is an ABI stable C interface provided by Node.js for building native
 addons. It is independent from the underlying JavaScript runtime (e.g. V8 or ChakraCore)
 and is maintained as part of Node.js itself. It is intended to insulate
@@ -21,7 +29,7 @@ It is important to remember that *other* Node.js interfaces such as
 `libuv` (included in a project via `#include <uv.h>`) are not ABI-stable across
 Node.js major versions. Thus, an addon must use N-API and/or `node-addon-api`
 exclusively and build against a version of Node.js that includes an
-implementation of N-API (meaning a version of Node.js newer than 6.14.2) in
+implementation of N-API (meaning an active LTS version of Node.js) in
 order to benefit from ABI stability across Node.js major versions. Node.js
 provides an [ABI stability guide][] containing a detailed explanation of ABI
 stability in general, and the N-API ABI stability guarantee in particular.
@@ -37,16 +45,21 @@ APIs exposed by node-addon-api are generally used to create and
 manipulate JavaScript values. Concepts and operations generally map
 to ideas specified in the **ECMA262 Language Specification**.
 
+The [N-API Resource](https://nodejs.github.io/node-addon-examples/) offers an
+excellent orientation and tips for developers just getting started with N-API
+and node-addon-api.
+
 - **[Setup](#setup)**
 - **[API Documentation](#api)**
 - **[Examples](#examples)**
 - **[Tests](#tests)**
 - **[More resource and info about native Addons](#resources)**
+- **[Badges](#badges)**
 - **[Code of Conduct](CODE_OF_CONDUCT.md)**
 - **[Contributors](#contributors)**
 - **[License](#license)**
 
-## **Current version: 2.0.2**
+## **Current version: 3.1.0**
 
 (See [CHANGELOG.md](CHANGELOG.md) for complete Changelog)
 
@@ -54,6 +67,13 @@ to ideas specified in the **ECMA262 Language Specification**.
 
 <a name="setup"></a>
 
+node-addon-api is based on [N-API](https://nodejs.org/api/n-api.html) and supports using different N-API versions.
+This allows addons built with it to run with Node.js versions which support the targeted N-API version.
+**However** the node-addon-api support model is to support only the active LTS Node.js versions. This means that
+every year there will be a new major which drops support for the Node.js LTS version which has gone out of service.
+
+The oldest Node.js version supported by the current version of node-addon-api is Node.js 10.x.
+
 ## Setup
   - [Installation and usage](doc/setup.md)
   - [node-gyp](doc/node-gyp.md)
@@ -69,31 +89,25 @@ to ideas specified in the **ECMA262 Language Specification**.
 
 The following is the documentation for node-addon-api.
 
- - [Basic Types](doc/basic_types.md)
-    - [Array](doc/basic_types.md#array)
-    - [Symbol](doc/symbol.md)
-    - [String](doc/string.md)
-    - [Name](doc/basic_types.md#name)
-    - [Number](doc/number.md)
-    - [Date](doc/date.md)
-    - [BigInt](doc/bigint.md)
-    - [Boolean](doc/boolean.md)
+ - [Full Class Hierarchy](doc/hierarchy.md)
+ - [Addon Structure](doc/addon.md)
+ - Data Types:
     - [Env](doc/env.md)
-    - [Value](doc/value.md)
     - [CallbackInfo](doc/callbackinfo.md)
     - [Reference](doc/reference.md)
-    - [External](doc/external.md)
-    - [Object](doc/object.md)
-        - [ObjectReference](doc/object_reference.md)
-        - [PropertyDescriptor](doc/property_descriptor.md)
- - [Error Handling](doc/error_handling.md)
-    - [Error](doc/error.md)
-    - [TypeError](doc/type_error.md)
-    - [RangeError](doc/range_error.md)
- - [Object Lifetime Management](doc/object_lifetime_management.md)
-    - [HandleScope](doc/handle_scope.md)
-    - [EscapableHandleScope](doc/escapable_handle_scope.md)
- - [Working with JavaScript Values](doc/working_with_javascript_values.md)
+    - [Value](doc/value.md)
+        - [Name](doc/name.md)
+            - [Symbol](doc/symbol.md)
+            - [String](doc/string.md)
+        - [Number](doc/number.md)
+        - [Date](doc/date.md)
+        - [BigInt](doc/bigint.md)
+        - [Boolean](doc/boolean.md)
+        - [External](doc/external.md)
+        - [Object](doc/object.md)
+            - [Array](doc/array.md)
+            - [ObjectReference](doc/object_reference.md)
+    - [PropertyDescriptor](doc/property_descriptor.md)
     - [Function](doc/function.md)
         - [FunctionReference](doc/function_reference.md)
     - [ObjectWrap](doc/object_wrap.md)
@@ -103,12 +117,21 @@ The following is the documentation for node-addon-api.
     - [TypedArray](doc/typed_array.md)
       - [TypedArrayOf](doc/typed_array_of.md)
     - [DataView](doc/dataview.md)
+ - [Error Handling](doc/error_handling.md)
+    - [Error](doc/error.md)
+      - [TypeError](doc/type_error.md)
+      - [RangeError](doc/range_error.md)
+ - [Object Lifetime Management](doc/object_lifetime_management.md)
+    - [HandleScope](doc/handle_scope.md)
+    - [EscapableHandleScope](doc/escapable_handle_scope.md)
  - [Memory Management](doc/memory_management.md)
  - [Async Operations](doc/async_operations.md)
     - [AsyncWorker](doc/async_worker.md)
     - [AsyncContext](doc/async_context.md)
-    - [AsyncProgressWorker](doc/async_progress_worker.md)
- - [Thread-safe Functions](doc/threadsafe_function.md)
+    - [AsyncWorker Variants](doc/async_worker_variants.md)
+ - [Thread-safe Functions](doc/threadsafe.md)
+    - [ThreadSafeFunction](doc/threadsafe_function.md)
+    - [TypedThreadSafeFunction](doc/typed_threadsafe_function.md)
  - [Promises](doc/promises.md)
  - [Version management](doc/version_management.md)
 
@@ -144,6 +167,15 @@ npm install
 npm test --disable-deprecated
 ```
 
+To run the tests targetting a specific version of N-API run
+```
+npm install
+export NAPI_VERSION=X
+npm test --NAPI_VERSION=X
+```
+
+where X is the version of N-API you want to target.
+
 ### **Debug**
 
 To run the **node-addon-api** tests with `--debug` option:
@@ -160,26 +192,63 @@ npm run-script dev:incremental
 
 Take a look and get inspired by our **[test suite](https://github.com/nodejs/node-addon-api/tree/master/test)**
 
-<a name="resources"></a>
+### **Benchmarks**
 
-## **Contributing**
+You can run the available benchmarks using the following command:
 
-We love contributions from the community to **node-addon-api**.
-See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around extending this module.
+```
+npm run-script benchmark
+```
+
+See [benchmark/README.md](benchmark/README.md) for more details about running and adding benchmarks.
+
+<a name="resources"></a>
 
 ### **More resource and info about native Addons**
 - **[C++ Addons](https://nodejs.org/dist/latest/docs/api/addons.html)**
 - **[N-API](https://nodejs.org/dist/latest/docs/api/n-api.html)**
 - **[N-API - Next Generation Node API for Native Modules](https://youtu.be/-Oniup60Afs)**
 
+As node-addon-api's core mission is to expose the plain C N-API as C++
+wrappers, tools that facilitate n-api/node-addon-api providing more
+convenient patterns on developing a Node.js add-ons with n-api/node-addon-api
+can be published to NPM as standalone packages. It is also recommended to tag
+such packages with `node-addon-api` to provide more visibility to the community.
+
+Quick links to NPM searches: [keywords:node-addon-api](https://www.npmjs.com/search?q=keywords%3Anode-addon-api).
+
+<a name="badges"></a>
+
+### **Badges**
+
+The use of badges is recommended to indicate the minimum version of N-API
+required for the module. This helps to determine which Node.js major versions are
+supported. Addon maintainers can consult the [N-API support matrix][] to determine
+which Node.js versions provide a given N-API version. The following badges are
+available:
+
+![N-API v1 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/N-API%20v1%20Badge.svg)
+![N-API v2 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/N-API%20v2%20Badge.svg)
+![N-API v3 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/N-API%20v3%20Badge.svg)
+![N-API v4 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/N-API%20v4%20Badge.svg)
+![N-API v5 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/N-API%20v5%20Badge.svg)
+![N-API v6 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/N-API%20v6%20Badge.svg)
+![N-API Experimental Version Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/N-API%20Experimental%20Version%20Badge.svg)
+
+## **Contributing**
+
+We love contributions from the community to **node-addon-api**!
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around extending this module.
+
 <a name="contributors"></a>
 
-## WG Members / Collaborators
+## Team members
 
 ### Active
 | Name                | GitHub Link                                           |
 | ------------------- | ----------------------------------------------------- |
 | Anna Henningsen     | [addaleax](https://github.com/addaleax)               |
+| Chengzhong Wu       | [legendecas](https://github.com/legendecas)           |
 | Gabriel Schulhof    | [gabrielschulhof](https://github.com/gabrielschulhof) |
 | Hitesh Kanwathirtha | [digitalinfinity](https://github.com/digitalinfinity) |
 | Jim Schlight        | [jschlight](https://github.com/jschlight)             |
@@ -201,3 +270,4 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around
 Licensed under [MIT](./LICENSE.md)
 
 [ABI stability guide]: https://nodejs.org/en/docs/guides/abi-stability/
+[N-API support matrix]: https://nodejs.org/dist/latest/docs/api/n-api.html#n_api_n_api_version_matrix

package/appveyor.yml

@@ -1,24 +1,13 @@
 environment:
   # https://github.com/jasongin/nvs/blob/master/doc/CI.md
   NVS_VERSION: 1.4.2
-  fast_finish: true
   matrix:
-    - NODEJS_VERSION: node/4
-    - NODEJS_VERSION: node/6
-    - NODEJS_VERSION: node/8
-    - NODEJS_VERSION: node/9
     - NODEJS_VERSION: node/10
-    - NODEJS_VERSION: chakracore/8
-    - NODEJS_VERSION: chakracore/10
+    - NODEJS_VERSION: node/12
+    - NODEJS_VERSION: node/14
     - NODEJS_VERSION: nightly
-    - NODEJS_VERSION: chakracore-nightly
-
-matrix:
-  fast_finish: true
-  allow_failures:
-    - NODEJS_VERSION: nightly
-    - NODEJS_VERSION: chakracore-nightly
 
+os: Visual Studio 2017
 platform:
   - x86
   - x64

package/benchmark/README.md

@@ -0,0 +1,47 @@
+# Benchmarks
+
+## Running the benchmarks
+
+From the parent directory, run
+
+```bash
+npm run-script benchmark
+```
+
+The above script supports the following arguments:
+
+* `--benchmarks=...`: A semicolon-separated list of benchmark names. These names
+    will be mapped to file names in this directory by appending `.js`.
+
+## Adding benchmarks
+
+The steps below should be followed when adding new benchmarks.
+
+0. Decide on a name for the benchmark. This name will be used in several places.
+   This example will use the name `new_benchmark`.
+
+0. Create files `new_benchmark.cc` and `new_benchmark.js` in this directory.
+
+0. Copy an existing benchmark in `binding.gyp` and change the target name prefix
+    and the source file name to `new_benchmark`. This should result in two new
+    targets which look like this:
+
+    ```gyp
+      {
+        'target_name': 'new_benchmark',
+        'sources': [ 'new_benchmark.cc' ],
+        'includes': [ '../except.gypi' ],
+      },
+      {
+        'target_name': 'new_benchmark_noexcept',
+        'sources': [ 'new_benchmark.cc' ],
+        'includes': [ '../noexcept.gypi' ],
+      },
+    ```
+
+    There should always be a pair of targets: one bearing the name of the
+    benchmark and configured with C++ exceptions enabled, and one bearing the
+    same name followed by the suffix `_noexcept` and configured with C++
+    exceptions disabled. This will ensure that the benchmark can be written to
+    cover both the case where C++ exceptions are enabled and the case where they
+    are disabled.

package/benchmark/binding.gyp

@@ -0,0 +1,25 @@
+{
+  'target_defaults': { 'includes': ['../common.gypi'] },
+  'targets': [
+    {
+      'target_name': 'function_args',
+      'sources': [ 'function_args.cc' ],
+      'includes': [ '../except.gypi' ],
+    },
+    {
+      'target_name': 'function_args_noexcept',
+      'sources': [ 'function_args.cc' ],
+      'includes': [ '../noexcept.gypi' ],
+    },
+    {
+      'target_name': 'property_descriptor',
+      'sources': [ 'property_descriptor.cc' ],
+      'includes': [ '../except.gypi' ],
+    },
+    {
+      'target_name': 'property_descriptor_noexcept',
+      'sources': [ 'property_descriptor.cc' ],
+      'includes': [ '../noexcept.gypi' ],
+    },
+  ]
+}

package/benchmark/function_args.cc

@@ -0,0 +1,217 @@
+#include "napi.h"
+
+static napi_value NoArgFunction_Core(napi_env env, napi_callback_info info) {
+  (void) env;
+  (void) info;
+  return nullptr;
+}
+
+static napi_value OneArgFunction_Core(napi_env env, napi_callback_info info) {
+  size_t argc = 1;
+  napi_value argv;
+  if (napi_get_cb_info(env, info, &argc, &argv, nullptr, nullptr) != napi_ok) {
+    return nullptr;
+  }
+  (void) argv;
+  return nullptr;
+}
+
+static napi_value TwoArgFunction_Core(napi_env env, napi_callback_info info) {
+  size_t argc = 2;
+  napi_value argv[2];
+  if (napi_get_cb_info(env, info, &argc, argv, nullptr, nullptr) != napi_ok) {
+    return nullptr;
+  }
+  (void) argv[0];
+  (void) argv[1];
+  return nullptr;
+}
+
+static napi_value ThreeArgFunction_Core(napi_env env, napi_callback_info info) {
+  size_t argc = 3;
+  napi_value argv[3];
+  if (napi_get_cb_info(env, info, &argc, argv, nullptr, nullptr) != napi_ok) {
+    return nullptr;
+  }
+  (void) argv[0];
+  (void) argv[1];
+  (void) argv[2];
+  return nullptr;
+}
+
+static napi_value FourArgFunction_Core(napi_env env, napi_callback_info info) {
+  size_t argc = 4;
+  napi_value argv[4];
+  if (napi_get_cb_info(env, info, &argc, argv, nullptr, nullptr) != napi_ok) {
+    return nullptr;
+  }
+  (void) argv[0];
+  (void) argv[1];
+  (void) argv[2];
+  (void) argv[3];
+  return nullptr;
+}
+
+static void NoArgFunction(const Napi::CallbackInfo& info) {
+  (void) info;
+}
+
+static void OneArgFunction(const Napi::CallbackInfo& info) {
+  Napi::Value argv0 = info[0]; (void) argv0;
+}
+
+static void TwoArgFunction(const Napi::CallbackInfo& info) {
+  Napi::Value argv0 = info[0]; (void) argv0;
+  Napi::Value argv1 = info[1]; (void) argv1;
+}
+
+static void ThreeArgFunction(const Napi::CallbackInfo& info) {
+  Napi::Value argv0 = info[0]; (void) argv0;
+  Napi::Value argv1 = info[1]; (void) argv1;
+  Napi::Value argv2 = info[2]; (void) argv2;
+}
+
+static void FourArgFunction(const Napi::CallbackInfo& info) {
+  Napi::Value argv0 = info[0]; (void) argv0;
+  Napi::Value argv1 = info[1]; (void) argv1;
+  Napi::Value argv2 = info[2]; (void) argv2;
+  Napi::Value argv3 = info[3]; (void) argv3;
+}
+
+#if NAPI_VERSION > 5
+class FunctionArgsBenchmark : public Napi::Addon<FunctionArgsBenchmark> {
+ public:
+  FunctionArgsBenchmark(Napi::Env env, Napi::Object exports) {
+    DefineAddon(exports, {
+      InstanceValue("addon", DefineProperties(Napi::Object::New(env), {
+        InstanceMethod("noArgFunction", &FunctionArgsBenchmark::NoArgFunction),
+        InstanceMethod("oneArgFunction",
+                       &FunctionArgsBenchmark::OneArgFunction),
+        InstanceMethod("twoArgFunction",
+                       &FunctionArgsBenchmark::TwoArgFunction),
+        InstanceMethod("threeArgFunction",
+                       &FunctionArgsBenchmark::ThreeArgFunction),
+        InstanceMethod("fourArgFunction",
+                       &FunctionArgsBenchmark::FourArgFunction),
+      }), napi_enumerable),
+      InstanceValue("addon_templated",
+        DefineProperties(Napi::Object::New(env), {
+          InstanceMethod<&FunctionArgsBenchmark::NoArgFunction>(
+                                                            "noArgFunction"),
+          InstanceMethod<&FunctionArgsBenchmark::OneArgFunction>(
+                                                            "oneArgFunction"),
+          InstanceMethod<&FunctionArgsBenchmark::TwoArgFunction>(
+                                                            "twoArgFunction"),
+          InstanceMethod<&FunctionArgsBenchmark::ThreeArgFunction>(
+                                                            "threeArgFunction"),
+          InstanceMethod<&FunctionArgsBenchmark::FourArgFunction>(
+                                                            "fourArgFunction"),
+        }), napi_enumerable),
+    });
+  }
+ private:
+  void NoArgFunction(const Napi::CallbackInfo& info) {
+    (void) info;
+  }
+
+  void OneArgFunction(const Napi::CallbackInfo& info) {
+    Napi::Value argv0 = info[0]; (void) argv0;
+  }
+
+  void TwoArgFunction(const Napi::CallbackInfo& info) {
+    Napi::Value argv0 = info[0]; (void) argv0;
+    Napi::Value argv1 = info[1]; (void) argv1;
+  }
+
+  void ThreeArgFunction(const Napi::CallbackInfo& info) {
+    Napi::Value argv0 = info[0]; (void) argv0;
+    Napi::Value argv1 = info[1]; (void) argv1;
+    Napi::Value argv2 = info[2]; (void) argv2;
+  }
+
+  void FourArgFunction(const Napi::CallbackInfo& info) {
+    Napi::Value argv0 = info[0]; (void) argv0;
+    Napi::Value argv1 = info[1]; (void) argv1;
+    Napi::Value argv2 = info[2]; (void) argv2;
+    Napi::Value argv3 = info[3]; (void) argv3;
+  }
+};
+#endif  // NAPI_VERSION > 5
+
+static Napi::Object Init(Napi::Env env, Napi::Object exports) {
+  napi_value no_arg_function, one_arg_function, two_arg_function,
+      three_arg_function, four_arg_function;
+  napi_status status;
+
+  status = napi_create_function(env,
+                                "noArgFunction",
+                                NAPI_AUTO_LENGTH,
+                                NoArgFunction_Core,
+                                nullptr,
+                                &no_arg_function);
+  NAPI_THROW_IF_FAILED(env, status, Napi::Object());
+
+  status = napi_create_function(env,
+                                "oneArgFunction",
+                                NAPI_AUTO_LENGTH,
+                                OneArgFunction_Core,
+                                nullptr,
+                                &one_arg_function);
+  NAPI_THROW_IF_FAILED(env, status, Napi::Object());
+
+  status = napi_create_function(env,
+                                "twoArgFunction",
+                                NAPI_AUTO_LENGTH,
+                                TwoArgFunction_Core,
+                                nullptr,
+                                &two_arg_function);
+  NAPI_THROW_IF_FAILED(env, status, Napi::Object());
+
+  status = napi_create_function(env,
+                                "threeArgFunction",
+                                NAPI_AUTO_LENGTH,
+                                ThreeArgFunction_Core,
+                                nullptr,
+                                &three_arg_function);
+  NAPI_THROW_IF_FAILED(env, status, Napi::Object());
+
+  status = napi_create_function(env,
+                                "fourArgFunction",
+                                NAPI_AUTO_LENGTH,
+                                FourArgFunction_Core,
+                                nullptr,
+                                &four_arg_function);
+  NAPI_THROW_IF_FAILED(env, status, Napi::Object());
+
+  Napi::Object core = Napi::Object::New(env);
+  core["noArgFunction"] = Napi::Value(env, no_arg_function);
+  core["oneArgFunction"] = Napi::Value(env, one_arg_function);
+  core["twoArgFunction"] = Napi::Value(env, two_arg_function);
+  core["threeArgFunction"] = Napi::Value(env, three_arg_function);
+  core["fourArgFunction"] = Napi::Value(env, four_arg_function);
+  exports["core"] = core;
+
+  Napi::Object cplusplus = Napi::Object::New(env);
+  cplusplus["noArgFunction"] = Napi::Function::New(env, NoArgFunction);
+  cplusplus["oneArgFunction"] = Napi::Function::New(env, OneArgFunction);
+  cplusplus["twoArgFunction"] = Napi::Function::New(env, TwoArgFunction);
+  cplusplus["threeArgFunction"] = Napi::Function::New(env, ThreeArgFunction);
+  cplusplus["fourArgFunction"] = Napi::Function::New(env, FourArgFunction);
+  exports["cplusplus"] = cplusplus;
+
+  Napi::Object templated = Napi::Object::New(env);
+  templated["noArgFunction"] = Napi::Function::New<NoArgFunction>(env);
+  templated["oneArgFunction"] = Napi::Function::New<OneArgFunction>(env);
+  templated["twoArgFunction"] = Napi::Function::New<TwoArgFunction>(env);
+  templated["threeArgFunction"] = Napi::Function::New<ThreeArgFunction>(env);
+  templated["fourArgFunction"] = Napi::Function::New<FourArgFunction>(env);
+  exports["templated"] = templated;
+
+#if NAPI_VERSION > 5
+  FunctionArgsBenchmark::Init(env, exports);
+#endif  // NAPI_VERSION > 5
+
+  return exports;
+}
+
+NODE_API_MODULE(NODE_GYP_MODULE_NAME, Init)

package/benchmark/function_args.js

@@ -0,0 +1,60 @@
+const path = require('path');
+const Benchmark = require('benchmark');
+const addonName = path.basename(__filename, '.js');
+
+[ addonName, addonName + '_noexcept' ]
+  .forEach((addonName) => {
+    const rootAddon = require('bindings')({
+      bindings: addonName,
+      module_root: __dirname
+    });
+    delete rootAddon.path;
+    const implems = Object.keys(rootAddon);
+    const maxNameLength =
+      implems.reduce((soFar, value) => Math.max(soFar, value.length), 0);
+    const anObject = {};
+
+    console.log(`\n${addonName}: `);
+
+    console.log('no arguments:');
+    implems.reduce((suite, implem) => {
+      const fn = rootAddon[implem].noArgFunction;
+      return suite.add(implem.padStart(maxNameLength, ' '), () => fn());
+    }, new Benchmark.Suite)
+      .on('cycle', (event) => console.log(String(event.target)))
+      .run();
+
+    console.log('one argument:');
+    implems.reduce((suite, implem) => {
+      const fn = rootAddon[implem].oneArgFunction;
+      return suite.add(implem.padStart(maxNameLength, ' '), () => fn('x'));
+    }, new Benchmark.Suite)
+      .on('cycle', (event) => console.log(String(event.target)))
+      .run();
+
+    console.log('two arguments:');
+    implems.reduce((suite, implem) => {
+      const fn = rootAddon[implem].twoArgFunction;
+      return suite.add(implem.padStart(maxNameLength, ' '), () => fn('x', 12));
+    }, new Benchmark.Suite)
+      .on('cycle', (event) => console.log(String(event.target)))
+      .run();
+
+    console.log('three arguments:');
+    implems.reduce((suite, implem) => {
+      const fn = rootAddon[implem].threeArgFunction;
+      return suite.add(implem.padStart(maxNameLength, ' '),
+        () => fn('x', 12, true));
+    }, new Benchmark.Suite)
+      .on('cycle', (event) => console.log(String(event.target)))
+      .run();
+
+    console.log('four arguments:');
+    implems.reduce((suite, implem) => {
+      const fn = rootAddon[implem].fourArgFunction;
+      return suite.add(implem.padStart(maxNameLength, ' '),
+        () => fn('x', 12, true, anObject));
+    }, new Benchmark.Suite)
+      .on('cycle', (event) => console.log(String(event.target)))
+      .run();
+  });

package/benchmark/index.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const { readdirSync } = require('fs');
+const { spawnSync } = require('child_process');
+const path = require('path');
+
+let benchmarks = [];
+
+if (!!process.env.npm_config_benchmarks) {
+  benchmarks = process.env.npm_config_benchmarks
+    .split(';')
+    .map((item) => (item + '.js'));
+}
+
+// Run each file in this directory or the list given on the command line except
+// index.js as a Node.js process.
+(benchmarks.length > 0 ? benchmarks : readdirSync(__dirname))
+  .filter((item) => (item !== 'index.js' && item.match(/\.js$/)))
+  .map((item) => path.join(__dirname, item))
+  .forEach((item) => {
+    const child = spawnSync(process.execPath, [
+      '--expose-gc',
+      item
+    ], { stdio: 'inherit' });
+    if (child.signal) {
+      console.error(`Tests aborted with ${child.signal}`);
+      process.exitCode = 1;
+    } else {
+      process.exitCode = child.status;
+    }
+    if (child.status !== 0) {
+      process.exit(process.exitCode);
+    }
+  });