koffi 0.9.6 → 0.9.7

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

@@ -1,196 +1,196 @@
-# Env
-
-The opaque data structure containing the environment in which the request is being run.
-
-The Env object is usually created and passed by the Node.js runtime or node-addon-api infrastructure.
-
-## Methods
-
-### Constructor
-
-```cpp
-Napi::Env::Env(napi_env env);
-```
-
-- `[in] env`: The `napi_env` environment from which to construct the `Napi::Env` object.
-
-### napi_env
-
-```cpp
-operator napi_env() const;
-```
-
-Returns the `napi_env` opaque data structure representing the environment.
-
-### Global
-
-```cpp
-Napi::Object Napi::Env::Global() const;
-```
-
-Returns the `Napi::Object` representing the environment's JavaScript Global Object.
-
-### Undefined
-
-```cpp
-Napi::Value Napi::Env::Undefined() const;
-```
-
-Returns the `Napi::Value` representing the environment's JavaScript Undefined Object.
-
-### Null
-
-```cpp
-Napi::Value Napi::Env::Null() const;
-```
-
-Returns the `Napi::Value` representing the environment's JavaScript Null Object.
-
-### IsExceptionPending
-
-```cpp
-bool Napi::Env::IsExceptionPending() const;
-```
-
-Returns a `bool` indicating if an exception is pending in the environment.
-
-### GetAndClearPendingException
-
-```cpp
-Napi::Error Napi::Env::GetAndClearPendingException();
-```
-
-Returns an `Napi::Error` object representing the environment's pending exception, if any.
-
-### RunScript
-
-```cpp
-Napi::Value Napi::Env::RunScript(____ script);
-```
-- `[in] script`: A string containing JavaScript code to execute.
-
-Runs JavaScript code contained in a string and returns its result.
-
-The `script` can be any of the following types:
-- [`Napi::String`](string.md)
-- `const char *`
-- `const std::string &`
-
-### GetInstanceData
-```cpp
-template <typename T> T* GetInstanceData();
-```
-
-Returns the instance data that was previously associated with the environment,
-or `nullptr` if none was associated.
-
-### SetInstanceData
-
-```cpp
-template <typename T> using Finalizer = void (*)(Env, T*);
-template <typename T, Finalizer<T> fini = Env::DefaultFini<T>>
-void SetInstanceData(T* data);
-```
-
-- `[template] fini`: A function to call when the instance data is to be deleted.
-Accepts a function of the form `void CleanupData(Napi::Env env, T* data)`. If
-not given, the default finalizer will be used, which simply uses the `delete`
-operator to destroy `T*` when the addon instance is unloaded.
-- `[in] data`: A pointer to data that will be associated with the instance of
-the addon for the duration of its lifecycle.
-
-Associates a data item stored at `T* data` with the current instance of the
-addon. The item will be passed to the function `fini` which gets called when an
-instance of the addon is unloaded.
-
-### SetInstanceData
-
-```cpp
-template <typename DataType, typename HintType>
-using FinalizerWithHint = void (*)(Env, DataType*, HintType*);
-template <typename DataType,
-          typename HintType,
-          FinalizerWithHint<DataType, HintType> fini =
-            Env::DefaultFiniWithHint<DataType, HintType>>
-void SetInstanceData(DataType* data, HintType* hint);
-```
-
-- `[template] fini`: A function to call when the instance data is to be deleted.
-Accepts a function of the form
-`void CleanupData(Napi::Env env, DataType* data, HintType* hint)`. If not given,
-the default finalizer will be used, which simply uses the `delete` operator to
-destroy `T*` when the addon instance is unloaded.
-- `[in] data`: A pointer to data that will be associated with the instance of
-the addon for the duration of its lifecycle.
-- `[in] hint`: A pointer to data that will be associated with the instance of
-the addon for the duration of its lifecycle and will be passed as a hint to
-`fini` when the addon instance is unloaded.
-
-Associates a data item stored at `T* data` with the current instance of the
-addon. The item will be passed to the function `fini` which gets called when an
-instance of the addon is unloaded. This overload accepts an additional hint to
-be passed to `fini`.
-
-### AddCleanupHook
-
-```cpp
-template <typename Hook>
-CleanupHook<Hook> AddCleanupHook(Hook hook);
-```
-
-- `[in] hook`: A function to call when the environment exists. Accepts a
-  function of the form `void ()`.
-
-Registers `hook` as a function to be run once the current Node.js environment
-exits. Unlike the underlying C-based Node-API, providing the same `hook`
-multiple times **is** allowed. The hooks will be called in reverse order, i.e.
-the most recently added one will be called first.
-
-Returns an `Env::CleanupHook` object, which can be used to remove the hook via
-its `Remove()` method.
-
-### AddCleanupHook
-
-```cpp
-template <typename Hook, typename Arg>
-CleanupHook<Hook, Arg> AddCleanupHook(Hook hook, Arg* arg);
-```
-
-- `[in] hook`: A function to call when the environment exists. Accepts a
-  function of the form `void (Arg* arg)`.
-- `[in] arg`: A pointer to data that will be passed as the argument to `hook`.
-
-Registers `hook` as a function to be run with the `arg` parameter once the
-current Node.js environment exits. Unlike the underlying C-based Node-API,
-providing the same `hook` and `arg` pair multiple times **is** allowed. The
-hooks will be called in reverse order, i.e. the most recently added one will be
-called first.
-
-Returns an `Env::CleanupHook` object, which can be used to remove the hook via
-its `Remove()` method.
-
-# Env::CleanupHook
-
-The `Env::CleanupHook` object allows removal of the hook added via
-`Env::AddCleanupHook()`
-
-## Methods
-
-### IsEmpty
-
-```cpp
-bool IsEmpty();
-```
-
-Returns `true` if the cleanup hook was **not** successfully registered.
-
-### Remove
-
-```cpp
-bool Remove(Env env);
-```
-
-Unregisters the hook from running once the current Node.js environment exits.
-
-Returns `true` if the hook was successfully removed from the Node.js
-environment.
+# Env
+
+The opaque data structure containing the environment in which the request is being run.
+
+The Env object is usually created and passed by the Node.js runtime or node-addon-api infrastructure.
+
+## Methods
+
+### Constructor
+
+```cpp
+Napi::Env::Env(napi_env env);
+```
+
+- `[in] env`: The `napi_env` environment from which to construct the `Napi::Env` object.
+
+### napi_env
+
+```cpp
+operator napi_env() const;
+```
+
+Returns the `napi_env` opaque data structure representing the environment.
+
+### Global
+
+```cpp
+Napi::Object Napi::Env::Global() const;
+```
+
+Returns the `Napi::Object` representing the environment's JavaScript Global Object.
+
+### Undefined
+
+```cpp
+Napi::Value Napi::Env::Undefined() const;
+```
+
+Returns the `Napi::Value` representing the environment's JavaScript Undefined Object.
+
+### Null
+
+```cpp
+Napi::Value Napi::Env::Null() const;
+```
+
+Returns the `Napi::Value` representing the environment's JavaScript Null Object.
+
+### IsExceptionPending
+
+```cpp
+bool Napi::Env::IsExceptionPending() const;
+```
+
+Returns a `bool` indicating if an exception is pending in the environment.
+
+### GetAndClearPendingException
+
+```cpp
+Napi::Error Napi::Env::GetAndClearPendingException();
+```
+
+Returns an `Napi::Error` object representing the environment's pending exception, if any.
+
+### RunScript
+
+```cpp
+Napi::Value Napi::Env::RunScript(____ script);
+```
+- `[in] script`: A string containing JavaScript code to execute.
+
+Runs JavaScript code contained in a string and returns its result.
+
+The `script` can be any of the following types:
+- [`Napi::String`](string.md)
+- `const char *`
+- `const std::string &`
+
+### GetInstanceData
+```cpp
+template <typename T> T* GetInstanceData();
+```
+
+Returns the instance data that was previously associated with the environment,
+or `nullptr` if none was associated.
+
+### SetInstanceData
+
+```cpp
+template <typename T> using Finalizer = void (*)(Env, T*);
+template <typename T, Finalizer<T> fini = Env::DefaultFini<T>>
+void SetInstanceData(T* data);
+```
+
+- `[template] fini`: A function to call when the instance data is to be deleted.
+Accepts a function of the form `void CleanupData(Napi::Env env, T* data)`. If
+not given, the default finalizer will be used, which simply uses the `delete`
+operator to destroy `T*` when the addon instance is unloaded.
+- `[in] data`: A pointer to data that will be associated with the instance of
+the addon for the duration of its lifecycle.
+
+Associates a data item stored at `T* data` with the current instance of the
+addon. The item will be passed to the function `fini` which gets called when an
+instance of the addon is unloaded.
+
+### SetInstanceData
+
+```cpp
+template <typename DataType, typename HintType>
+using FinalizerWithHint = void (*)(Env, DataType*, HintType*);
+template <typename DataType,
+          typename HintType,
+          FinalizerWithHint<DataType, HintType> fini =
+            Env::DefaultFiniWithHint<DataType, HintType>>
+void SetInstanceData(DataType* data, HintType* hint);
+```
+
+- `[template] fini`: A function to call when the instance data is to be deleted.
+Accepts a function of the form
+`void CleanupData(Napi::Env env, DataType* data, HintType* hint)`. If not given,
+the default finalizer will be used, which simply uses the `delete` operator to
+destroy `T*` when the addon instance is unloaded.
+- `[in] data`: A pointer to data that will be associated with the instance of
+the addon for the duration of its lifecycle.
+- `[in] hint`: A pointer to data that will be associated with the instance of
+the addon for the duration of its lifecycle and will be passed as a hint to
+`fini` when the addon instance is unloaded.
+
+Associates a data item stored at `T* data` with the current instance of the
+addon. The item will be passed to the function `fini` which gets called when an
+instance of the addon is unloaded. This overload accepts an additional hint to
+be passed to `fini`.
+
+### AddCleanupHook
+
+```cpp
+template <typename Hook>
+CleanupHook<Hook> AddCleanupHook(Hook hook);
+```
+
+- `[in] hook`: A function to call when the environment exists. Accepts a
+  function of the form `void ()`.
+
+Registers `hook` as a function to be run once the current Node.js environment
+exits. Unlike the underlying C-based Node-API, providing the same `hook`
+multiple times **is** allowed. The hooks will be called in reverse order, i.e.
+the most recently added one will be called first.
+
+Returns an `Env::CleanupHook` object, which can be used to remove the hook via
+its `Remove()` method.
+
+### AddCleanupHook
+
+```cpp
+template <typename Hook, typename Arg>
+CleanupHook<Hook, Arg> AddCleanupHook(Hook hook, Arg* arg);
+```
+
+- `[in] hook`: A function to call when the environment exists. Accepts a
+  function of the form `void (Arg* arg)`.
+- `[in] arg`: A pointer to data that will be passed as the argument to `hook`.
+
+Registers `hook` as a function to be run with the `arg` parameter once the
+current Node.js environment exits. Unlike the underlying C-based Node-API,
+providing the same `hook` and `arg` pair multiple times **is** allowed. The
+hooks will be called in reverse order, i.e. the most recently added one will be
+called first.
+
+Returns an `Env::CleanupHook` object, which can be used to remove the hook via
+its `Remove()` method.
+
+# Env::CleanupHook
+
+The `Env::CleanupHook` object allows removal of the hook added via
+`Env::AddCleanupHook()`
+
+## Methods
+
+### IsEmpty
+
+```cpp
+bool IsEmpty();
+```
+
+Returns `true` if the cleanup hook was **not** successfully registered.
+
+### Remove
+
+```cpp
+bool Remove(Env env);
+```
+
+Unregisters the hook from running once the current Node.js environment exits.
+
+Returns `true` if the hook was successfully removed from the Node.js
+environment.

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

@@ -1,120 +1,120 @@
-# Error
-
-Class `Napi::Error` inherits from class [`Napi::ObjectReference`][] and class [`std::exception`][].
-
-The `Napi::Error` class is a representation of the JavaScript `Error` object that is thrown
-when runtime errors occur. The Error object can also be used as a base object for
-user-defined exceptions.
-
-The `Napi::Error` class is a persistent reference to a JavaScript error object thus
-inherits its behavior from the `Napi::ObjectReference` class (for more info see: [`Napi::ObjectReference`](object_reference.md)).
-
-If C++ exceptions are enabled (for more info see: [Setup](setup.md)), then the
-`Napi::Error` class extends `std::exception` and enables integrated
-error-handling for C++ exceptions and JavaScript exceptions.
-
-For more details about error handling refer to the section titled [Error handling](error_handling.md).
-
-## Methods
-
-### New
-
-Creates empty instance of an `Napi::Error` object for the specified environment.
-
-```cpp
-Napi::Error::New(Napi::Env env);
-```
-
-- `[in] env`: The environment in which to construct the `Napi::Error` object.
-
-Returns an instance of `Napi::Error` object.
-
-### New
-
-Creates instance of an `Napi::Error` object.
-
-```cpp
-Napi::Error::New(Napi::Env env, const char* message);
-```
-
-- `[in] env`: The environment in which to construct the `Napi::Error` object.
-- `[in] message`: Null-terminated string to be used as the message for the `Napi::Error`.
-
-Returns instance of an `Napi::Error` object.
-
-### New
-
-Creates instance of an `Napi::Error` object
-
-```cpp
-Napi::Error::New(Napi::Env env, const std::string& message);
-```
-
-- `[in] env`: The environment in which to construct the `Napi::Error` object.
-- `[in] message`: Reference string to be used as the message for the `Napi::Error`.
-
-Returns instance of an `Napi::Error` object.
-
-### Fatal
-
-In case of an unrecoverable error in a native module, a fatal error can be thrown
-to immediately terminate the process.
-
-```cpp
-static NAPI_NO_RETURN void Napi::Error::Fatal(const char* location, const char* message);
-```
-
-The function call does not return, the process will be terminated.
-
-### Constructor
-
-Creates empty instance of an `Napi::Error`.
-
-```cpp
-Napi::Error::Error();
-```
-
-Returns an instance of `Napi::Error` object.
-
-### Constructor
-
-Initializes an `Napi::Error` instance from an existing JavaScript error object.
-
-```cpp
-Napi::Error::Error(napi_env env, napi_value value);
-```
-
-- `[in] env`: The environment in which to construct the error object.
-- `[in] value`: The `Napi::Error` reference to wrap.
-
-Returns instance of an `Napi::Error` object.
-
-### Message
-
-```cpp
-std::string& Napi::Error::Message() const NAPI_NOEXCEPT;
-```
-
-Returns the reference to the string that represent the message of the error.
-
-### ThrowAsJavaScriptException
-
-Throw the error as JavaScript exception.
-
-```cpp
-void Napi::Error::ThrowAsJavaScriptException() const;
-```
-
-Throws the error as a JavaScript exception.
-
-### what
-
-```cpp
-const char* Napi::Error::what() const NAPI_NOEXCEPT override;
-```
-
-Returns a pointer to a null-terminated string that is used to identify the
-exception. This method can be used only if the exception mechanism is enabled.
-
-[`Napi::ObjectReference`]: ./object_reference.md
-[`std::exception`]: https://cplusplus.com/reference/exception/exception/
+# Error
+
+Class `Napi::Error` inherits from class [`Napi::ObjectReference`][] and class [`std::exception`][].
+
+The `Napi::Error` class is a representation of the JavaScript `Error` object that is thrown
+when runtime errors occur. The Error object can also be used as a base object for
+user-defined exceptions.
+
+The `Napi::Error` class is a persistent reference to a JavaScript error object thus
+inherits its behavior from the `Napi::ObjectReference` class (for more info see: [`Napi::ObjectReference`](object_reference.md)).
+
+If C++ exceptions are enabled (for more info see: [Setup](setup.md)), then the
+`Napi::Error` class extends `std::exception` and enables integrated
+error-handling for C++ exceptions and JavaScript exceptions.
+
+For more details about error handling refer to the section titled [Error handling](error_handling.md).
+
+## Methods
+
+### New
+
+Creates empty instance of an `Napi::Error` object for the specified environment.
+
+```cpp
+Napi::Error::New(Napi::Env env);
+```
+
+- `[in] env`: The environment in which to construct the `Napi::Error` object.
+
+Returns an instance of `Napi::Error` object.
+
+### New
+
+Creates instance of an `Napi::Error` object.
+
+```cpp
+Napi::Error::New(Napi::Env env, const char* message);
+```
+
+- `[in] env`: The environment in which to construct the `Napi::Error` object.
+- `[in] message`: Null-terminated string to be used as the message for the `Napi::Error`.
+
+Returns instance of an `Napi::Error` object.
+
+### New
+
+Creates instance of an `Napi::Error` object
+
+```cpp
+Napi::Error::New(Napi::Env env, const std::string& message);
+```
+
+- `[in] env`: The environment in which to construct the `Napi::Error` object.
+- `[in] message`: Reference string to be used as the message for the `Napi::Error`.
+
+Returns instance of an `Napi::Error` object.
+
+### Fatal
+
+In case of an unrecoverable error in a native module, a fatal error can be thrown
+to immediately terminate the process.
+
+```cpp
+static NAPI_NO_RETURN void Napi::Error::Fatal(const char* location, const char* message);
+```
+
+The function call does not return, the process will be terminated.
+
+### Constructor
+
+Creates empty instance of an `Napi::Error`.
+
+```cpp
+Napi::Error::Error();
+```
+
+Returns an instance of `Napi::Error` object.
+
+### Constructor
+
+Initializes an `Napi::Error` instance from an existing JavaScript error object.
+
+```cpp
+Napi::Error::Error(napi_env env, napi_value value);
+```
+
+- `[in] env`: The environment in which to construct the error object.
+- `[in] value`: The `Napi::Error` reference to wrap.
+
+Returns instance of an `Napi::Error` object.
+
+### Message
+
+```cpp
+std::string& Napi::Error::Message() const NAPI_NOEXCEPT;
+```
+
+Returns the reference to the string that represent the message of the error.
+
+### ThrowAsJavaScriptException
+
+Throw the error as JavaScript exception.
+
+```cpp
+void Napi::Error::ThrowAsJavaScriptException() const;
+```
+
+Throws the error as a JavaScript exception.
+
+### what
+
+```cpp
+const char* Napi::Error::what() const NAPI_NOEXCEPT override;
+```
+
+Returns a pointer to a null-terminated string that is used to identify the
+exception. This method can be used only if the exception mechanism is enabled.
+
+[`Napi::ObjectReference`]: ./object_reference.md
+[`std::exception`]: https://cplusplus.com/reference/exception/exception/