koffi 0.9.3 → 0.9.6

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

@@ -1,97 +1,97 @@
-# BigInt
-
-Class `Napi::Bigint` inherits from class [`Napi::Value`][].
-
-A JavaScript BigInt value.
-
-## Methods
-
-### New
-
-```cpp
-static Napi::BigInt Napi::BigInt::New(Napi::Env env, int64_t value);
-static Napi::BigInt Napi::BigInt::New(Napi::Env env, uint64_t value);
-```
-
- - `[in] env`: The environment in which to construct the `Napi::BigInt` object.
- - `[in] value`: The value the JavaScript `BigInt` will contain
-
-These APIs convert the C `int64_t` and `uint64_t` types to the JavaScript
-`BigInt` type.
-
-```cpp
-static Napi::BigInt Napi::BigInt::New(Napi::Env env,
-                  int sign_bit,
-                  size_t word_count,
-                  const uint64_t* words);
-```
-
- - `[in] env`: The environment in which to construct the `Napi::BigInt` object.
- - `[in] sign_bit`: Determines if the resulting `BigInt` will be positive or negative.
- - `[in] word_count`: The length of the words array.
- - `[in] words`: An array of `uint64_t` little-endian 64-bit words.
-
-This API converts an array of unsigned 64-bit words into a single `BigInt`
-value.
-
-The resulting `BigInt` is calculated as: (–1)<sup>`sign_bit`</sup> (`words[0]`
-× (2<sup>64</sup>)<sup>0</sup> + `words[1]` × (2<sup>64</sup>)<sup>1</sup> + …)
-
-Returns a new JavaScript `BigInt`.
-
-### Constructor
-
-```cpp
-Napi::BigInt();
-```
-
-Returns a new empty JavaScript `Napi::BigInt`.
-
-### Int64Value
-
-```cpp
-int64_t Napi::BigInt::Int64Value(bool* lossless) const;
-```
-
- - `[out] lossless`: Indicates whether the `BigInt` value was converted losslessly.
-
-Returns the C `int64_t` primitive equivalent of the given JavaScript
-`BigInt`. If needed it will truncate the value, setting lossless to false.
-
-### Uint64Value
-
-```cpp
-uint64_t Napi::BigInt::Uint64Value(bool* lossless) const;
-```
-
- - `[out] lossless`: Indicates whether the `BigInt` value was converted
-   losslessly.
-
-Returns the C `uint64_t` primitive equivalent of the given JavaScript
-`BigInt`. If needed it will truncate the value, setting lossless to false.
-
-### WordCount
-
-```cpp
-size_t Napi::BigInt::WordCount() const;
-```
-
-Returns the number of words needed to store this `BigInt` value.
-
-### ToWords
-
-```cpp
-void Napi::BigInt::ToWords(int* sign_bit, size_t* word_count, uint64_t* words);
-```
-
- - `[out] sign_bit`: Integer representing if the JavaScript `BigInt` is positive
-   or negative.
- - `[in/out] word_count`: Must be initialized to the length of the words array.
-   Upon return, it will be set to the actual number of words that would be
-   needed to store this `BigInt`.
- - `[out] words`: Pointer to a pre-allocated 64-bit word array.
-
-Returns a single `BigInt` value into a sign bit, 64-bit little-endian array,
-and the number of elements in the array.
-
-[`Napi::Value`]: ./value.md
+# BigInt
+
+Class `Napi::Bigint` inherits from class [`Napi::Value`][].
+
+A JavaScript BigInt value.
+
+## Methods
+
+### New
+
+```cpp
+static Napi::BigInt Napi::BigInt::New(Napi::Env env, int64_t value);
+static Napi::BigInt Napi::BigInt::New(Napi::Env env, uint64_t value);
+```
+
+ - `[in] env`: The environment in which to construct the `Napi::BigInt` object.
+ - `[in] value`: The value the JavaScript `BigInt` will contain
+
+These APIs convert the C `int64_t` and `uint64_t` types to the JavaScript
+`BigInt` type.
+
+```cpp
+static Napi::BigInt Napi::BigInt::New(Napi::Env env,
+                  int sign_bit,
+                  size_t word_count,
+                  const uint64_t* words);
+```
+
+ - `[in] env`: The environment in which to construct the `Napi::BigInt` object.
+ - `[in] sign_bit`: Determines if the resulting `BigInt` will be positive or negative.
+ - `[in] word_count`: The length of the words array.
+ - `[in] words`: An array of `uint64_t` little-endian 64-bit words.
+
+This API converts an array of unsigned 64-bit words into a single `BigInt`
+value.
+
+The resulting `BigInt` is calculated as: (–1)<sup>`sign_bit`</sup> (`words[0]`
+× (2<sup>64</sup>)<sup>0</sup> + `words[1]` × (2<sup>64</sup>)<sup>1</sup> + …)
+
+Returns a new JavaScript `BigInt`.
+
+### Constructor
+
+```cpp
+Napi::BigInt();
+```
+
+Returns a new empty JavaScript `Napi::BigInt`.
+
+### Int64Value
+
+```cpp
+int64_t Napi::BigInt::Int64Value(bool* lossless) const;
+```
+
+ - `[out] lossless`: Indicates whether the `BigInt` value was converted losslessly.
+
+Returns the C `int64_t` primitive equivalent of the given JavaScript
+`BigInt`. If needed it will truncate the value, setting lossless to false.
+
+### Uint64Value
+
+```cpp
+uint64_t Napi::BigInt::Uint64Value(bool* lossless) const;
+```
+
+ - `[out] lossless`: Indicates whether the `BigInt` value was converted
+   losslessly.
+
+Returns the C `uint64_t` primitive equivalent of the given JavaScript
+`BigInt`. If needed it will truncate the value, setting lossless to false.
+
+### WordCount
+
+```cpp
+size_t Napi::BigInt::WordCount() const;
+```
+
+Returns the number of words needed to store this `BigInt` value.
+
+### ToWords
+
+```cpp
+void Napi::BigInt::ToWords(int* sign_bit, size_t* word_count, uint64_t* words);
+```
+
+ - `[out] sign_bit`: Integer representing if the JavaScript `BigInt` is positive
+   or negative.
+ - `[in/out] word_count`: Must be initialized to the length of the words array.
+   Upon return, it will be set to the actual number of words that would be
+   needed to store this `BigInt`.
+ - `[out] words`: Pointer to a pre-allocated 64-bit word array.
+
+Returns a single `BigInt` value into a sign bit, 64-bit little-endian array,
+and the number of elements in the array.
+
+[`Napi::Value`]: ./value.md

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

@@ -1,68 +1,68 @@
-# Boolean
-
-Class `Napi::Boolean` inherits from class [`Napi::Value`][].
-
-`Napi::Boolean` class is a representation of the JavaScript `Boolean` object. The
-`Napi::Boolean` 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 an `Napi::Boolean` object.
-
-```cpp
-Napi::Boolean::Boolean();
-```
-
-Returns a new _empty_  `Napi::Boolean` object.
-
-### Constructor
-
-Creates a new instance of the `Napi::Boolean` object.
-
-```cpp
-Napi::Boolean(napi_env env, napi_value value);
-```
-
-- `[in] env`: The `napi_env` environment in which to construct the `Napi::Boolean` object.
-- `[in] value`: The `napi_value` which is a handle for a JavaScript `Boolean`.
-
-Returns a non-empty `Napi::Boolean` object.
-
-### New
-
-Initializes a new instance of the `Napi::Boolean` object.
-
-```cpp
-Napi::Boolean Napi::Boolean::New(napi_env env, bool value);
-```
-- `[in] env`: The `napi_env` environment in which to construct the `Napi::Boolean` object.
-- `[in] value`: The primitive boolean value (`true` or `false`).
-
-Returns a new instance of the `Napi::Boolean` object.
-
-### Value
-
-Converts a `Napi::Boolean` value to a boolean primitive.
-
-```cpp
-bool Napi::Boolean::Value() const;
-```
-
-Returns the boolean primitive type of the corresponding `Napi::Boolean` object.
-
-## Operators
-
-### operator bool
-
-Converts a `Napi::Boolean` value to a boolean primitive.
-
-```cpp
-Napi::Boolean::operator bool() const;
-```
-
-Returns the boolean primitive type of the corresponding `Napi::Boolean` object.
-
-[`Napi::Value`]: ./value.md
+# Boolean
+
+Class `Napi::Boolean` inherits from class [`Napi::Value`][].
+
+`Napi::Boolean` class is a representation of the JavaScript `Boolean` object. The
+`Napi::Boolean` 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 an `Napi::Boolean` object.
+
+```cpp
+Napi::Boolean::Boolean();
+```
+
+Returns a new _empty_  `Napi::Boolean` object.
+
+### Constructor
+
+Creates a new instance of the `Napi::Boolean` object.
+
+```cpp
+Napi::Boolean(napi_env env, napi_value value);
+```
+
+- `[in] env`: The `napi_env` environment in which to construct the `Napi::Boolean` object.
+- `[in] value`: The `napi_value` which is a handle for a JavaScript `Boolean`.
+
+Returns a non-empty `Napi::Boolean` object.
+
+### New
+
+Initializes a new instance of the `Napi::Boolean` object.
+
+```cpp
+Napi::Boolean Napi::Boolean::New(napi_env env, bool value);
+```
+- `[in] env`: The `napi_env` environment in which to construct the `Napi::Boolean` object.
+- `[in] value`: The primitive boolean value (`true` or `false`).
+
+Returns a new instance of the `Napi::Boolean` object.
+
+### Value
+
+Converts a `Napi::Boolean` value to a boolean primitive.
+
+```cpp
+bool Napi::Boolean::Value() const;
+```
+
+Returns the boolean primitive type of the corresponding `Napi::Boolean` object.
+
+## Operators
+
+### operator bool
+
+Converts a `Napi::Boolean` value to a boolean primitive.
+
+```cpp
+Napi::Boolean::operator bool() const;
+```
+
+Returns the boolean primitive type of the corresponding `Napi::Boolean` object.
+
+[`Napi::Value`]: ./value.md

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

@@ -1,150 +1,150 @@
-# Buffer
-
-Class `Napi::Buffer` inherits from class [`Napi::Uint8Array`][].
-
-The `Napi::Buffer` class creates a projection of raw data that can be consumed by
-script.
-
-## Methods
-
-### New
-
-Allocates a new `Napi::Buffer` object with a given length.
-
-```cpp
-static Napi::Buffer<T> Napi::Buffer::New(napi_env env, size_t length);
-```
-
-- `[in] env`: The environment in which to create the `Napi::Buffer` object.
-- `[in] length`: The number of `T` elements to allocate.
-
-Returns a new `Napi::Buffer` object.
-
-### New
-
-Wraps the provided external data into a new `Napi::Buffer` object.
-
-The `Napi::Buffer` object does not assume ownership for the data and expects it to be
-valid for the lifetime of the object. Since the `Napi::Buffer` is subject to garbage
-collection this overload is only suitable for data which is static and never
-needs to be freed.
-This factory method will not provide the caller with an opportunity to free the
-data when the `Napi::Buffer` gets garbage-collected. If you need to free the
-data retained by the `Napi::Buffer` object please use other variants of the
-`Napi::Buffer::New` factory method that accept `Napi::Finalizer`, which is a
-function that will be invoked when the `Napi::Buffer` object has been
-destroyed.
-
-```cpp
-static Napi::Buffer<T> Napi::Buffer::New(napi_env env, T* data, size_t length);
-```
-
-- `[in] env`: The environment in which to create the `Napi::Buffer` object.
-- `[in] data`: The pointer to the external data to expose.
-- `[in] length`: The number of `T` elements in the external data.
-
-Returns a new `Napi::Buffer` object.
-
-### New
-
-Wraps the provided external data into a new `Napi::Buffer` object.
-
-The `Napi::Buffer` object does not assume ownership for the data and expects it
-to be valid for the lifetime of the object. The data can only be freed once the
-`finalizeCallback` is invoked to indicate that the `Napi::Buffer` has been released.
-
-```cpp
-template <typename Finalizer>
-static Napi::Buffer<T> Napi::Buffer::New(napi_env env,
-                     T* data,
-                     size_t length,
-                     Finalizer finalizeCallback);
-```
-
-- `[in] env`: The environment in which to create the `Napi::Buffer` object.
-- `[in] data`: The pointer to the external data to expose.
-- `[in] length`: The number of `T` elements in the external data.
-- `[in] finalizeCallback`: The function to be called when the `Napi::Buffer` is
-  destroyed. It must implement `operator()`, accept a `T*` (which is the
-  external data pointer), and return `void`.
-
-Returns a new `Napi::Buffer` object.
-
-### New
-
-Wraps the provided external data into a new `Napi::Buffer` object.
-
-The `Napi::Buffer` object does not assume ownership for the data and expects it to be
-valid for the lifetime of the object. The data can only be freed once the
-`finalizeCallback` is invoked to indicate that the `Napi::Buffer` has been released.
-
-```cpp
-template <typename Finalizer, typename Hint>
-static Napi::Buffer<T> Napi::Buffer::New(napi_env env,
-                     T* data,
-                     size_t length,
-                     Finalizer finalizeCallback,
-                     Hint* finalizeHint);
-```
-
-- `[in] env`: The environment in which to create the `Napi::Buffer` object.
-- `[in] data`: The pointer to the external data to expose.
-- `[in] length`: The number of `T` elements in the external data.
-- `[in] finalizeCallback`: The function to be called when the `Napi::Buffer` is
-  destroyed. It must implement `operator()`, accept a `T*` (which is the
-  external data pointer) and `Hint*`, and return `void`.
-- `[in] finalizeHint`: The hint to be passed as the second parameter of the
-  finalize callback.
-
-Returns a new `Napi::Buffer` object.
-
-### Copy
-
-Allocates a new `Napi::Buffer` object and copies the provided external data into it.
-
-```cpp
-static Napi::Buffer<T> Napi::Buffer::Copy(napi_env env, const T* data, size_t length);
-```
-
-- `[in] env`: The environment in which to create the `Napi::Buffer` object.
-- `[in] data`: The pointer to the external data to copy.
-- `[in] length`: The number of `T` elements in the external data.
-
-Returns a new `Napi::Buffer` object containing a copy of the data.
-
-### Constructor
-
-Initializes an empty instance of the `Napi::Buffer` class.
-
-```cpp
-Napi::Buffer::Buffer();
-```
-
-### Constructor
-
-Initializes the `Napi::Buffer` object using an existing Uint8Array.
-
-```cpp
-Napi::Buffer::Buffer(napi_env env, napi_value value);
-```
-
-- `[in] env`: The environment in which to create the `Napi::Buffer` object.
-- `[in] value`: The Uint8Array reference to wrap.
-
-### Data
-
-```cpp
-T* Napi::Buffer::Data() const;
-```
-
-Returns a pointer the external data.
-
-### Length
-
-```cpp
-size_t Napi::Buffer::Length() const;
-```
-
-Returns the number of `T` elements in the external data.
-
-[`Napi::Uint8Array`]: ./typed_array_of.md
+# Buffer
+
+Class `Napi::Buffer` inherits from class [`Napi::Uint8Array`][].
+
+The `Napi::Buffer` class creates a projection of raw data that can be consumed by
+script.
+
+## Methods
+
+### New
+
+Allocates a new `Napi::Buffer` object with a given length.
+
+```cpp
+static Napi::Buffer<T> Napi::Buffer::New(napi_env env, size_t length);
+```
+
+- `[in] env`: The environment in which to create the `Napi::Buffer` object.
+- `[in] length`: The number of `T` elements to allocate.
+
+Returns a new `Napi::Buffer` object.
+
+### New
+
+Wraps the provided external data into a new `Napi::Buffer` object.
+
+The `Napi::Buffer` object does not assume ownership for the data and expects it to be
+valid for the lifetime of the object. Since the `Napi::Buffer` is subject to garbage
+collection this overload is only suitable for data which is static and never
+needs to be freed.
+This factory method will not provide the caller with an opportunity to free the
+data when the `Napi::Buffer` gets garbage-collected. If you need to free the
+data retained by the `Napi::Buffer` object please use other variants of the
+`Napi::Buffer::New` factory method that accept `Napi::Finalizer`, which is a
+function that will be invoked when the `Napi::Buffer` object has been
+destroyed.
+
+```cpp
+static Napi::Buffer<T> Napi::Buffer::New(napi_env env, T* data, size_t length);
+```
+
+- `[in] env`: The environment in which to create the `Napi::Buffer` object.
+- `[in] data`: The pointer to the external data to expose.
+- `[in] length`: The number of `T` elements in the external data.
+
+Returns a new `Napi::Buffer` object.
+
+### New
+
+Wraps the provided external data into a new `Napi::Buffer` object.
+
+The `Napi::Buffer` object does not assume ownership for the data and expects it
+to be valid for the lifetime of the object. The data can only be freed once the
+`finalizeCallback` is invoked to indicate that the `Napi::Buffer` has been released.
+
+```cpp
+template <typename Finalizer>
+static Napi::Buffer<T> Napi::Buffer::New(napi_env env,
+                     T* data,
+                     size_t length,
+                     Finalizer finalizeCallback);
+```
+
+- `[in] env`: The environment in which to create the `Napi::Buffer` object.
+- `[in] data`: The pointer to the external data to expose.
+- `[in] length`: The number of `T` elements in the external data.
+- `[in] finalizeCallback`: The function to be called when the `Napi::Buffer` is
+  destroyed. It must implement `operator()`, accept a `T*` (which is the
+  external data pointer), and return `void`.
+
+Returns a new `Napi::Buffer` object.
+
+### New
+
+Wraps the provided external data into a new `Napi::Buffer` object.
+
+The `Napi::Buffer` object does not assume ownership for the data and expects it to be
+valid for the lifetime of the object. The data can only be freed once the
+`finalizeCallback` is invoked to indicate that the `Napi::Buffer` has been released.
+
+```cpp
+template <typename Finalizer, typename Hint>
+static Napi::Buffer<T> Napi::Buffer::New(napi_env env,
+                     T* data,
+                     size_t length,
+                     Finalizer finalizeCallback,
+                     Hint* finalizeHint);
+```
+
+- `[in] env`: The environment in which to create the `Napi::Buffer` object.
+- `[in] data`: The pointer to the external data to expose.
+- `[in] length`: The number of `T` elements in the external data.
+- `[in] finalizeCallback`: The function to be called when the `Napi::Buffer` is
+  destroyed. It must implement `operator()`, accept a `T*` (which is the
+  external data pointer) and `Hint*`, and return `void`.
+- `[in] finalizeHint`: The hint to be passed as the second parameter of the
+  finalize callback.
+
+Returns a new `Napi::Buffer` object.
+
+### Copy
+
+Allocates a new `Napi::Buffer` object and copies the provided external data into it.
+
+```cpp
+static Napi::Buffer<T> Napi::Buffer::Copy(napi_env env, const T* data, size_t length);
+```
+
+- `[in] env`: The environment in which to create the `Napi::Buffer` object.
+- `[in] data`: The pointer to the external data to copy.
+- `[in] length`: The number of `T` elements in the external data.
+
+Returns a new `Napi::Buffer` object containing a copy of the data.
+
+### Constructor
+
+Initializes an empty instance of the `Napi::Buffer` class.
+
+```cpp
+Napi::Buffer::Buffer();
+```
+
+### Constructor
+
+Initializes the `Napi::Buffer` object using an existing Uint8Array.
+
+```cpp
+Napi::Buffer::Buffer(napi_env env, napi_value value);
+```
+
+- `[in] env`: The environment in which to create the `Napi::Buffer` object.
+- `[in] value`: The Uint8Array reference to wrap.
+
+### Data
+
+```cpp
+T* Napi::Buffer::Data() const;
+```
+
+Returns a pointer the external data.
+
+### Length
+
+```cpp
+size_t Napi::Buffer::Length() const;
+```
+
+Returns the number of `T` elements in the external data.
+
+[`Napi::Uint8Array`]: ./typed_array_of.md