koffi 1.1.0-beta.0 → 1.1.0-beta.3

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

@@ -0,0 +1,248 @@
+# DataView
+
+Class `Napi::DataView` inherits from class [`Napi::Object`][].
+
+The `Napi::DataView` class corresponds to the
+[JavaScript `DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView)
+class.
+
+## Methods
+
+### New
+
+Allocates a new `Napi::DataView` instance with a given `Napi::ArrayBuffer`.
+
+```cpp
+static Napi::DataView Napi::DataView::New(napi_env env, Napi::ArrayBuffer arrayBuffer);
+```
+
+- `[in] env`: The environment in which to create the `Napi::DataView` instance.
+- `[in] arrayBuffer` : `Napi::ArrayBuffer` underlying the `Napi::DataView`.
+
+Returns a new `Napi::DataView` instance.
+
+### New
+
+Allocates a new `Napi::DataView` instance with a given `Napi::ArrayBuffer`.
+
+```cpp
+static Napi::DataView Napi::DataView::New(napi_env env, Napi::ArrayBuffer arrayBuffer, size_t byteOffset);
+```
+
+- `[in] env`: The environment in which to create the `Napi::DataView` instance.
+- `[in] arrayBuffer` : `Napi::ArrayBuffer` underlying the `Napi::DataView`.
+- `[in] byteOffset` : The byte offset within the `Napi::ArrayBuffer` from which to start projecting the `Napi::DataView`.
+
+Returns a new `Napi::DataView` instance.
+
+### New
+
+Allocates a new `Napi::DataView` instance with a given `Napi::ArrayBuffer`.
+
+```cpp
+static Napi::DataView Napi::DataView::New(napi_env env, Napi::ArrayBuffer arrayBuffer, size_t byteOffset, size_t byteLength);
+```
+
+- `[in] env`: The environment in which to create the `Napi::DataView` instance.
+- `[in] arrayBuffer` : `Napi::ArrayBuffer` underlying the `Napi::DataView`.
+- `[in] byteOffset` : The byte offset within the `Napi::ArrayBuffer` from which to start projecting the `Napi::DataView`.
+- `[in] byteLength` : Number of elements in the `Napi::DataView`.
+
+Returns a new `Napi::DataView` instance.
+
+### Constructor
+
+Initializes an empty instance of the `Napi::DataView` class.
+
+```cpp
+Napi::DataView();
+```
+
+### Constructor
+
+Initializes a wrapper instance of an existing `Napi::DataView` instance.
+
+```cpp
+Napi::DataView(napi_env env, napi_value value);
+```
+
+- `[in] env`: The environment in which to create the `Napi::DataView` instance.
+- `[in] value`: The `Napi::DataView` reference to wrap.
+
+### ArrayBuffer
+
+```cpp
+Napi::ArrayBuffer Napi::DataView::ArrayBuffer() const;
+```
+
+Returns the backing array buffer.
+
+### ByteOffset
+
+```cpp
+size_t Napi::DataView::ByteOffset() const;
+```
+
+Returns the offset into the `Napi::DataView` where the array starts, in bytes.
+
+### ByteLength
+
+```cpp
+size_t Napi::DataView::ByteLength() const;
+```
+
+Returns the length of the array, in bytes.
+
+### GetFloat32
+
+```cpp
+float Napi::DataView::GetFloat32(size_t byteOffset) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+
+Returns a signed 32-bit float (float) at the specified byte offset from the start of the `Napi::DataView`.
+
+### GetFloat64
+
+```cpp
+double Napi::DataView::GetFloat64(size_t byteOffset) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+
+Returns a signed 64-bit float (double) at the specified byte offset from the start of the `Napi::DataView`.
+
+### GetInt8
+
+```cpp
+int8_t Napi::DataView::GetInt8(size_t byteOffset) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+
+Returns a signed 8-bit integer (byte) at the specified byte offset from the start of the `Napi::DataView`.
+
+### GetInt16
+
+```cpp
+int16_t Napi::DataView::GetInt16(size_t byteOffset) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+
+Returns a signed 16-bit integer (short) at the specified byte offset from the start of the `Napi::DataView`.
+
+### GetInt32
+
+```cpp
+int32_t Napi::DataView::GetInt32(size_t byteOffset) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+
+Returns a signed 32-bit integer (long) at the specified byte offset from the start of the `Napi::DataView`.
+
+### GetUint8
+
+```cpp
+uint8_t Napi::DataView::GetUint8(size_t byteOffset) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+
+Returns a unsigned 8-bit integer (unsigned byte) at the specified byte offset from the start of the `Napi::DataView`.
+
+### GetUint16
+
+```cpp
+uint16_t Napi::DataView::GetUint16(size_t byteOffset) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+
+Returns a unsigned 16-bit integer (unsigned short) at the specified byte offset from the start of the `Napi::DataView`.
+
+### GetUint32
+
+```cpp
+uint32_t Napi::DataView::GetUint32(size_t byteOffset) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+
+Returns a unsigned 32-bit integer (unsigned long) at the specified byte offset from the start of the `Napi::DataView`.
+
+### SetFloat32
+
+```cpp
+void Napi::DataView::SetFloat32(size_t byteOffset, float value) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+- `[in] value`: The value to set.
+
+### SetFloat64
+
+```cpp
+void Napi::DataView::SetFloat64(size_t byteOffset, double value) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+- `[in] value`: The value to set.
+
+### SetInt8
+
+```cpp
+void Napi::DataView::SetInt8(size_t byteOffset, int8_t value) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+- `[in] value`: The value to set.
+
+### SetInt16
+
+```cpp
+void Napi::DataView::SetInt16(size_t byteOffset, int16_t value) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+- `[in] value`: The value to set.
+
+### SetInt32
+
+```cpp
+void Napi::DataView::SetInt32(size_t byteOffset, int32_t value) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+- `[in] value`: The value to set.
+
+### SetUint8
+
+```cpp
+void Napi::DataView::SetUint8(size_t byteOffset, uint8_t value) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+- `[in] value`: The value to set.
+
+### SetUint16
+
+```cpp
+void Napi::DataView::SetUint16(size_t byteOffset, uint16_t value) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+- `[in] value`: The value to set.
+
+### SetUint32
+
+```cpp
+void Napi::DataView::SetUint32(size_t byteOffset, uint32_t value) const;
+```
+
+- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data.
+- `[in] value`: The value to set.
+
+[`Napi::Object`]: ./object.md

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

@@ -0,0 +1,68 @@
+# Date
+
+`Napi::Date` class is a representation of the JavaScript `Date` object. The
+`Napi::Date` class inherits its behavior from the `Napi::Value` class
+(for more info see [`Napi::Value`](value.md)).
+
+## Methods
+
+### Constructor
+
+Creates a new _empty_ instance of a `Napi::Date` object.
+
+```cpp
+Napi::Date::Date();
+```
+
+Creates a new _non-empty_ instance of a `Napi::Date` object.
+
+```cpp
+Napi::Date::Date(napi_env env, napi_value value);
+```
+
+ - `[in] env`: The environment in which to construct the `Napi::Date` object.
+ - `[in] value`: The `napi_value` which is a handle for a JavaScript `Date`.
+
+### New
+
+Creates a new instance of a `Napi::Date` object.
+
+```cpp
+static Napi::Date Napi::Date::New(Napi::Env env, double value);
+```
+
+ - `[in] env`: The environment in which to construct the `Napi::Date` object.
+ - `[in] value`: The time value the JavaScript `Date` will contain represented
+  as the number of milliseconds since 1 January 1970 00:00:00 UTC.
+
+Returns a new instance of `Napi::Date` object.
+
+### ValueOf
+
+```cpp
+double Napi::Date::ValueOf() const;
+```
+
+Returns the time value as `double` primitive represented as the number of
+ milliseconds since 1 January 1970 00:00:00 UTC.
+
+## Operators
+
+### operator double
+
+Converts a `Napi::Date` value to a `double` primitive.
+
+```cpp
+Napi::Date::operator double() const;
+```
+
+### Example
+
+The following shows an example of casting a `Napi::Date` value to a `double`
+ primitive.
+
+```cpp
+double operatorVal = Napi::Date::New(Env(), 0); // Napi::Date to double
+// or
+auto instanceVal = info[0].As<Napi::Date>().ValueOf();
+```

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

@@ -0,0 +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() const;
+```
+
+Returns an `Napi::Error` object representing the environment's pending exception, if any.
+
+### RunScript
+
+```cpp
+Napi::Value Napi::Env::RunScript(____ script) const;
+```
+- `[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() const;
+```
+
+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) const;
+```
+
+- `[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) const;
+```
+
+- `[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

@@ -0,0 +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/