koffi 0.9.4 → 0.9.5

package/vendor/node-addon-api/doc/range_error.md

@@ -1,59 +1,59 @@
-# RangeError
-
-The `Napi::RangeError` class is a representation of the JavaScript `RangeError` that is
-thrown when trying to pass a value as an argument to a function that does not allow
-a range that includes the value.
-
-The `Napi::RangeError` class inherits its behaviors from the `Napi::Error` class (for
-more info see: [`Napi::Error`](error.md)).
-
-For more details about error handling refer to the section titled [Error handling](error_handling.md).
-
-## Methods
-
-### New
-
-Creates a new instance of a `Napi::RangeError` object.
-
-```cpp
-Napi::RangeError::New(Napi::Env env, const char* message);
-```
-
-- `[in] Env`: The environment in which to construct the `Napi::RangeError` object.
-- `[in] message`: Null-terminated string to be used as the message for the `Napi::RangeError`.
-
-Returns an instance of a `Napi::RangeError` object.
-
-### New
-
-Creates a new instance of a `Napi::RangeError` object.
-
-```cpp
-Napi::RangeError::New(Napi::Env env, const std::string& message);
-```
-
-- `[in] Env`: The environment in which to construct the `Napi::RangeError` object.
-- `[in] message`: Reference string to be used as the message for the `Napi::RangeError`.
-
-Returns an instance of a `Napi::RangeError` object.
-
-### Constructor
-
-Creates a new empty instance of a `Napi::RangeError`.
-
-```cpp
-Napi::RangeError::RangeError();
-```
-
-### Constructor
-
-Initializes a `Napi::RangeError` instance from an existing Javascript error object.
-
-```cpp
-Napi::RangeError::RangeError(napi_env env, napi_value value);
-```
-
-- `[in] Env`: The environment in which to construct the `Napi::RangeError` object.
-- `[in] value`: The `Napi::Error` reference to wrap.
-
-Returns an instance of a `Napi::RangeError` object.
+# RangeError
+
+The `Napi::RangeError` class is a representation of the JavaScript `RangeError` that is
+thrown when trying to pass a value as an argument to a function that does not allow
+a range that includes the value.
+
+The `Napi::RangeError` class inherits its behaviors from the `Napi::Error` class (for
+more info see: [`Napi::Error`](error.md)).
+
+For more details about error handling refer to the section titled [Error handling](error_handling.md).
+
+## Methods
+
+### New
+
+Creates a new instance of a `Napi::RangeError` object.
+
+```cpp
+Napi::RangeError::New(Napi::Env env, const char* message);
+```
+
+- `[in] Env`: The environment in which to construct the `Napi::RangeError` object.
+- `[in] message`: Null-terminated string to be used as the message for the `Napi::RangeError`.
+
+Returns an instance of a `Napi::RangeError` object.
+
+### New
+
+Creates a new instance of a `Napi::RangeError` object.
+
+```cpp
+Napi::RangeError::New(Napi::Env env, const std::string& message);
+```
+
+- `[in] Env`: The environment in which to construct the `Napi::RangeError` object.
+- `[in] message`: Reference string to be used as the message for the `Napi::RangeError`.
+
+Returns an instance of a `Napi::RangeError` object.
+
+### Constructor
+
+Creates a new empty instance of a `Napi::RangeError`.
+
+```cpp
+Napi::RangeError::RangeError();
+```
+
+### Constructor
+
+Initializes a `Napi::RangeError` instance from an existing Javascript error object.
+
+```cpp
+Napi::RangeError::RangeError(napi_env env, napi_value value);
+```
+
+- `[in] Env`: The environment in which to construct the `Napi::RangeError` object.
+- `[in] value`: The `Napi::Error` reference to wrap.
+
+Returns an instance of a `Napi::RangeError` object.

package/vendor/node-addon-api/doc/reference.md

@@ -1,113 +1,113 @@
-# Reference (template)
-
-Holds a counted reference to a [`Napi::Value`](value.md) object; initially a weak reference unless otherwise specified, may be changed to/from a strong reference by adjusting the refcount.
-
-The referenced `Napi::Value` is not immediately destroyed when the reference count is zero; it is merely then eligible for garbage-collection if there are no other references to the `Napi::Value`.
-
-`Napi::Reference` objects allocated in static space, such as a global static instance, must call the `SuppressDestruct` method to prevent its destructor, running at program shutdown time, from attempting to reset the reference when the environment is no longer valid. Avoid using this if at all possible.
-
-The following classes inherit, either directly or indirectly, from `Napi::Reference`:
-
-* [`Napi::ObjectWrap`](object_wrap.md)
-* [`Napi::ObjectReference`](object_reference.md)
-* [`Napi::FunctionReference`](function_reference.md)
-
-## Methods
-
-### Factory Method
-
-```cpp
-static Napi::Reference<T> Napi::Reference::New(const T& value, uint32_t initialRefcount = 0);
-```
-
-* `[in] value`: The value which is to be referenced.
-
-* `[in] initialRefcount`: The initial reference count.
-
-### Empty Constructor
-
-```cpp
-Napi::Reference::Reference();
-```
-
-Creates a new _empty_ `Napi::Reference` instance.
-
-### Constructor
-
-```cpp
-Napi::Reference::Reference(napi_env env, napi_value value);
-```
-
-* `[in] env`: The `napi_env` environment in which to construct the `Napi::Reference` object.
-
-* `[in] value`: The Node-API primitive value to be held by the `Napi::Reference`.
-
-### Env
-
-```cpp
-Napi::Env Napi::Reference::Env() const;
-```
-
-Returns the `Napi::Env` value in which the `Napi::Reference` was instantiated.
-
-### IsEmpty
-
-```cpp
-bool Napi::Reference::IsEmpty() const;
-```
-
-Determines whether the value held by the `Napi::Reference` is empty.
-
-### Value
-
-```cpp
-T Napi::Reference::Value() const;
-```
-
-Returns the value held by the `Napi::Reference`.
-
-### Ref
-
-```cpp
-uint32_t Napi::Reference::Ref();
-```
-
-Increments the reference count for the `Napi::Reference` and returns the resulting reference count. Throws an error if the increment fails.
-
-### Unref
-
-```cpp
-uint32_t Napi::Reference::Unref();
-```
-
-Decrements the reference count for the `Napi::Reference` and returns the resulting reference count. Throws an error if the decrement fails.
-
-### Reset (Empty)
-
-```cpp
-void Napi::Reference::Reset();
-```
-
-Sets the value held by the `Napi::Reference` to be empty.
-
-### Reset
-
-```cpp
-void Napi::Reference::Reset(const T& value, uint32_t refcount = 0);
-```
-
-* `[in] value`: The value which is to be referenced.
-
-* `[in] initialRefcount`: The initial reference count.
-
-Sets the value held by the `Napi::Reference`.
-
-### SuppressDestruct
-
-```cpp
-void Napi::Reference::SuppressDestruct();
-```
-
-Call this method on a `Napi::Reference` that is declared as static data to prevent its destructor, running at program shutdown time, from attempting to reset the reference when the environment is no longer valid.
-
- Avoid using this if at all possible. If you do need to use static data, **MAKE SURE** to warn your users that your addon is **NOT** threadsafe.
+# Reference (template)
+
+Holds a counted reference to a [`Napi::Value`](value.md) object; initially a weak reference unless otherwise specified, may be changed to/from a strong reference by adjusting the refcount.
+
+The referenced `Napi::Value` is not immediately destroyed when the reference count is zero; it is merely then eligible for garbage-collection if there are no other references to the `Napi::Value`.
+
+`Napi::Reference` objects allocated in static space, such as a global static instance, must call the `SuppressDestruct` method to prevent its destructor, running at program shutdown time, from attempting to reset the reference when the environment is no longer valid. Avoid using this if at all possible.
+
+The following classes inherit, either directly or indirectly, from `Napi::Reference`:
+
+* [`Napi::ObjectWrap`](object_wrap.md)
+* [`Napi::ObjectReference`](object_reference.md)
+* [`Napi::FunctionReference`](function_reference.md)
+
+## Methods
+
+### Factory Method
+
+```cpp
+static Napi::Reference<T> Napi::Reference::New(const T& value, uint32_t initialRefcount = 0);
+```
+
+* `[in] value`: The value which is to be referenced.
+
+* `[in] initialRefcount`: The initial reference count.
+
+### Empty Constructor
+
+```cpp
+Napi::Reference::Reference();
+```
+
+Creates a new _empty_ `Napi::Reference` instance.
+
+### Constructor
+
+```cpp
+Napi::Reference::Reference(napi_env env, napi_value value);
+```
+
+* `[in] env`: The `napi_env` environment in which to construct the `Napi::Reference` object.
+
+* `[in] value`: The Node-API primitive value to be held by the `Napi::Reference`.
+
+### Env
+
+```cpp
+Napi::Env Napi::Reference::Env() const;
+```
+
+Returns the `Napi::Env` value in which the `Napi::Reference` was instantiated.
+
+### IsEmpty
+
+```cpp
+bool Napi::Reference::IsEmpty() const;
+```
+
+Determines whether the value held by the `Napi::Reference` is empty.
+
+### Value
+
+```cpp
+T Napi::Reference::Value() const;
+```
+
+Returns the value held by the `Napi::Reference`.
+
+### Ref
+
+```cpp
+uint32_t Napi::Reference::Ref();
+```
+
+Increments the reference count for the `Napi::Reference` and returns the resulting reference count. Throws an error if the increment fails.
+
+### Unref
+
+```cpp
+uint32_t Napi::Reference::Unref();
+```
+
+Decrements the reference count for the `Napi::Reference` and returns the resulting reference count. Throws an error if the decrement fails.
+
+### Reset (Empty)
+
+```cpp
+void Napi::Reference::Reset();
+```
+
+Sets the value held by the `Napi::Reference` to be empty.
+
+### Reset
+
+```cpp
+void Napi::Reference::Reset(const T& value, uint32_t refcount = 0);
+```
+
+* `[in] value`: The value which is to be referenced.
+
+* `[in] initialRefcount`: The initial reference count.
+
+Sets the value held by the `Napi::Reference`.
+
+### SuppressDestruct
+
+```cpp
+void Napi::Reference::SuppressDestruct();
+```
+
+Call this method on a `Napi::Reference` that is declared as static data to prevent its destructor, running at program shutdown time, from attempting to reset the reference when the environment is no longer valid.
+
+ Avoid using this if at all possible. If you do need to use static data, **MAKE SURE** to warn your users that your addon is **NOT** threadsafe.

package/vendor/node-addon-api/doc/setup.md

@@ -1,110 +1,110 @@
-# Setup
-
-## Prerequisites
-
-Before starting to use **Node-API** you need to assure you have the following
-prerequisites:
-
-* **Node.JS** see: [Installing Node.js](https://nodejs.org/)
-
-* **Node.js native addon build tool**
-
-  - **[node-gyp](node-gyp.md)**
-
-## Installation and usage
-
-To use **Node-API** in a native module:
-
-  1. Add a dependency on this package to `package.json`:
-
-```json
-  "dependencies": {
-    "node-addon-api": "*",
-  }
-```
-
-  2. Reference this package's include directory and gyp file in `binding.gyp`:
-
-```gyp
-  'include_dirs': ["<!(node -p \"require('node-addon-api').include_dir\")"],
-```
-
-  3. Decide whether the package will enable C++ exceptions in the Node-API wrapper.
-     The base ABI-stable C APIs do not throw or handle C++ exceptions, but the
-     Node-API C++ wrapper classes may _optionally_
-     [integrate C++ and JavaScript exception-handling
-     ](https://github.com/nodejs/node-addon-api/blob/HEAD/doc/error_handling.md).
-     To enable that capability, C++ exceptions must be enabled in `binding.gyp`:
-
-```gyp
-  'cflags!': [ '-fno-exceptions' ],
-  'cflags_cc!': [ '-fno-exceptions' ],
-  'conditions': [
-    ["OS=='win'", {
-      "defines": [
-        "_HAS_EXCEPTIONS=1"
-      ],
-      "msvs_settings": {
-        "VCCLCompilerTool": {
-          "ExceptionHandling": 1
-        },
-      },
-    }],
-    ["OS=='mac'", {
-      'xcode_settings': {
-        'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
-        'CLANG_CXX_LIBRARY': 'libc++',
-        'MACOSX_DEPLOYMENT_TARGET': '10.7',
-      },
-    }],
-  ],
-```
-
-  Alternatively, disable use of C++ exceptions in Node-API:
-
-```gyp
-  'defines': [ 'NAPI_DISABLE_CPP_EXCEPTIONS' ],
-```
-
-  If you decide to use node-addon-api without C++ exceptions enabled, please
-  consider enabling node-addon-api safe API type guards to ensure the proper
-  exception handling pattern:
-
-```gyp
-  'defines': [ 'NODE_ADDON_API_ENABLE_MAYBE' ],
-```
-
-  4. If you would like your native addon to support OSX, please also add the
-  following settings in the `binding.gyp` file:
-
-  ```gyp
-  'conditions': [
-    ['OS=="mac"', {
-        'cflags+': ['-fvisibility=hidden'],
-        'xcode_settings': {
-          'GCC_SYMBOLS_PRIVATE_EXTERN': 'YES', # -fvisibility=hidden
-        }
-    }]
-  ]
-  ```
-
-  5. Include `napi.h` in the native module code.
-     To ensure only ABI-stable APIs are used, DO NOT include
-     `node.h`, `nan.h`, or `v8.h`.
-
-```C++
-#include "napi.h"
-```
-
-At build time, the Node-API back-compat library code will be used only when the
-targeted node version *does not* have Node-API built-in.
-
-The preprocessor directive `NODE_ADDON_API_DISABLE_DEPRECATED` can be defined at
-compile time before including `napi.h` to skip the definition of deprecated APIs.
-
-By default, throwing an exception on a terminating environment (eg. worker
-threads) will cause a fatal exception, terminating the Node process. This is to
-provide feedback to the user of the runtime error, as it is impossible to pass
-the error to JavaScript when the environment is terminating. In order to bypass
-this behavior such that the Node process will not terminate, define the
-preprocessor directive `NODE_API_SWALLOW_UNTHROWABLE_EXCEPTIONS`.
+# Setup
+
+## Prerequisites
+
+Before starting to use **Node-API** you need to assure you have the following
+prerequisites:
+
+* **Node.JS** see: [Installing Node.js](https://nodejs.org/)
+
+* **Node.js native addon build tool**
+
+  - **[node-gyp](node-gyp.md)**
+
+## Installation and usage
+
+To use **Node-API** in a native module:
+
+  1. Add a dependency on this package to `package.json`:
+
+```json
+  "dependencies": {
+    "node-addon-api": "*",
+  }
+```
+
+  2. Reference this package's include directory and gyp file in `binding.gyp`:
+
+```gyp
+  'include_dirs': ["<!(node -p \"require('node-addon-api').include_dir\")"],
+```
+
+  3. Decide whether the package will enable C++ exceptions in the Node-API wrapper.
+     The base ABI-stable C APIs do not throw or handle C++ exceptions, but the
+     Node-API C++ wrapper classes may _optionally_
+     [integrate C++ and JavaScript exception-handling
+     ](https://github.com/nodejs/node-addon-api/blob/HEAD/doc/error_handling.md).
+     To enable that capability, C++ exceptions must be enabled in `binding.gyp`:
+
+```gyp
+  'cflags!': [ '-fno-exceptions' ],
+  'cflags_cc!': [ '-fno-exceptions' ],
+  'conditions': [
+    ["OS=='win'", {
+      "defines": [
+        "_HAS_EXCEPTIONS=1"
+      ],
+      "msvs_settings": {
+        "VCCLCompilerTool": {
+          "ExceptionHandling": 1
+        },
+      },
+    }],
+    ["OS=='mac'", {
+      'xcode_settings': {
+        'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
+        'CLANG_CXX_LIBRARY': 'libc++',
+        'MACOSX_DEPLOYMENT_TARGET': '10.7',
+      },
+    }],
+  ],
+```
+
+  Alternatively, disable use of C++ exceptions in Node-API:
+
+```gyp
+  'defines': [ 'NAPI_DISABLE_CPP_EXCEPTIONS' ],
+```
+
+  If you decide to use node-addon-api without C++ exceptions enabled, please
+  consider enabling node-addon-api safe API type guards to ensure the proper
+  exception handling pattern:
+
+```gyp
+  'defines': [ 'NODE_ADDON_API_ENABLE_MAYBE' ],
+```
+
+  4. If you would like your native addon to support OSX, please also add the
+  following settings in the `binding.gyp` file:
+
+  ```gyp
+  'conditions': [
+    ['OS=="mac"', {
+        'cflags+': ['-fvisibility=hidden'],
+        'xcode_settings': {
+          'GCC_SYMBOLS_PRIVATE_EXTERN': 'YES', # -fvisibility=hidden
+        }
+    }]
+  ]
+  ```
+
+  5. Include `napi.h` in the native module code.
+     To ensure only ABI-stable APIs are used, DO NOT include
+     `node.h`, `nan.h`, or `v8.h`.
+
+```C++
+#include "napi.h"
+```
+
+At build time, the Node-API back-compat library code will be used only when the
+targeted node version *does not* have Node-API built-in.
+
+The preprocessor directive `NODE_ADDON_API_DISABLE_DEPRECATED` can be defined at
+compile time before including `napi.h` to skip the definition of deprecated APIs.
+
+By default, throwing an exception on a terminating environment (eg. worker
+threads) will cause a fatal exception, terminating the Node process. This is to
+provide feedback to the user of the runtime error, as it is impossible to pass
+the error to JavaScript when the environment is terminating. In order to bypass
+this behavior such that the Node process will not terminate, define the
+preprocessor directive `NODE_API_SWALLOW_UNTHROWABLE_EXCEPTIONS`.