koffi 2.16.0-beta.2 → 2.16.0

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

@@ -1,200 +0,0 @@
-# BasicEnv
-
-The data structure containing the environment in which the request is being run.
-
-The `Napi::BasicEnv` object is usually created and passed by the Node.js runtime
-or node-addon-api infrastructure.
-
-The `Napi::BasicEnv` object represents an environment that has a limited subset
-of APIs when compared to `Napi::Env` and can be used in basic finalizers. See
-[Finalization][] for more details.
-
-## Methods
-
-### Constructor
-
-```cpp
-Napi::BasicEnv::BasicEnv(node_api_nogc_env env);
-```
-
-- `[in] env`: The `node_api_nogc_env` environment from which to construct the
-  `Napi::BasicEnv` object.
-
-### node_api_nogc_env
-
-```cpp
-operator node_api_nogc_env() const;
-```
-
-Returns the `node_api_nogc_env` opaque data structure representing the
-environment.
-
-### 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 add-on instance is unloaded.
-- `[in] data`: A pointer to data that will be associated with the instance of
-the add-on for the duration of its lifecycle.
-
-Associates a data item stored at `T* data` with the current instance of the
-add-on. The item will be passed to the function `fini` which gets called when an
-instance of the add-on 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 add-on instance is unloaded.
-- `[in] data`: A pointer to data that will be associated with the instance of
-the add-on for the duration of its lifecycle.
-- `[in] hint`: A pointer to data that will be associated with the instance of
-the add-on for the duration of its lifecycle and will be passed as a hint to
-`fini` when the add-on instance is unloaded.
-
-Associates a data item stored at `T* data` with the current instance of the
-add-on. The item will be passed to the function `fini` which gets called when an
-instance of the add-on is unloaded. This overload accepts an additional hint to
-be passed to `fini`.
-
-### GetModuleFileName
-
-```cpp
-const char* Napi::Env::GetModuleFileName() const;
-```
-
-Returns a URL containing the absolute path of the location from which the add-on
-was loaded. For a file on the local file system it will start with `file://`.
-The string is null-terminated and owned by env and must thus not be modified or
-freed. It is only valid while the add-on is loaded.
-
-### AddCleanupHook
-
-```cpp
-template <typename Hook>
-CleanupHook<Hook> AddCleanupHook(Hook hook);
-```
-
-- `[in] hook`: A function to call when the environment exits. 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.
-
-### PostFinalizer
-
-```cpp
-template <typename FinalizerType>
-inline void PostFinalizer(FinalizerType finalizeCallback) const;
-```
-
-- `[in] finalizeCallback`: The function to queue for execution outside of the GC
-  finalization, implementing `operator()(Napi::Env)`. See [Finalization][] for
-  more details.
-
-### PostFinalizer
-
-```cpp
-template <typename FinalizerType, typename T>
-inline void PostFinalizer(FinalizerType finalizeCallback, T* data) const;
-```
-
-- `[in] finalizeCallback`: The function to queue for execution outside of the GC
-  finalization, implementing `operator()(Napi::Env, T*)`. See [Finalization][]
-  for more details.
-- `[in] data`: The data to associate with the object.
-
-### PostFinalizer
-
-```cpp
-template <typename FinalizerType, typename T, typename Hint>
-inline void PostFinalizer(FinalizerType finalizeCallback,
-                          T* data,
-                          Hint* finalizeHint) const;
-```
-
-- `[in] finalizeCallback`: The function to queue for execution outside of the GC
-  finalization, implementing `operator()(Napi::Env, T*, Hint*)`. See
-  [Finalization][] for more details.
-- `[in] data`: The data to associate with the object.
-- `[in] finalizeHint`: The hint value passed to the `finalizeCallback` function.
-
-### AddCleanupHook
-
-```cpp
-template <typename Hook, typename Arg>
-CleanupHook<Hook, Arg> AddCleanupHook(Hook hook, Arg* arg);
-```
-
-- `[in] hook`: A function to call when the environment exits. 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.
-
-[Finalization]: ./finalization.md

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

@@ -1,97 +0,0 @@
-# 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 +0,0 @@
-# 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,245 +0,0 @@
-# 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
-
-> When `NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED` is defined, this method is not available.
-> See [External Buffer][] for more information.
-
-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 `Finalizer`, which is a function that will be invoked when the
-`Napi::Buffer` object has been destroyed. See [Finalization][] for more details.
-
-```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
-
-> When `NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED` is defined, this method is not available.
-> See [External Buffer][] for more information.
-
-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 called when the engine destroys the
-  `Napi::Buffer` object, implementing `operator()(Napi::BasicEnv, T*)`. See
-  [Finalization][] for more details.
-
-Returns a new `Napi::Buffer` object.
-
-### New
-
-> When `NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED` is defined, this method is not available.
-> See [External Buffer][] for more information.
-
-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 called when the engine destroys the
-  `Napi::Buffer` object, implementing `operator()(Napi::BasicEnv, T*, Hint*)`.
-  See [Finalization][] for more details.
-- `[in] finalizeHint`: The hint value passed to the `finalizeCallback` function.
-
-Returns a new `Napi::Buffer` object.
-
-### NewOrCopy
-
-Wraps the provided external data into a new `Napi::Buffer` object. When the
-[external buffer][] is not supported, allocates a new `Napi::Buffer` object and
-copies the provided external data into it.
-
-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::NewOrCopy(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.
-
-### NewOrCopy
-
-Wraps the provided external data into a new `Napi::Buffer` object. When the
-[external buffer][] is not supported, allocates a new `Napi::Buffer` object and
-copies the provided external data into it and the `finalizeCallback` is invoked
-immediately.
-
-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::NewOrCopy(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 called when the engine destroys the
-  `Napi::Buffer` object, implementing `operator()(Napi::BasicEnv, T*)`. See
-  [Finalization][] for more details.
-
-Returns a new `Napi::Buffer` object.
-
-### NewOrCopy
-
-Wraps the provided external data into a new `Napi::Buffer` object. When the
-[external buffer][] is not supported, allocates a new `Napi::Buffer` object and
-copies the provided external data into it and the `finalizeCallback` is invoked
-immediately.
-
-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::NewOrCopy(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 called when the engine destroys the
-  `Napi::Buffer` object, implementing `operator()(Napi::BasicEnv, T*, Hint*)`.
-  See [Finalization][] for more details.
-- `[in] finalizeHint`: The hint value passed to the `finalizeCallback` function.
-
-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
-[External Buffer]: ./external_buffer.md
-[Finalization]: ./finalization.md

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

@@ -1,54 +0,0 @@
-# CallbackScope
-
-There are cases (for example, resolving promises) where it is necessary to have
-the equivalent of the scope associated with a callback in place when making
-certain Node-API calls.
-
-## Methods
-
-### Constructor
-
-Creates a new callback scope on the stack.
-
-```cpp
-Napi::CallbackScope::CallbackScope(napi_env env, napi_callback_scope scope);
-```
-
-- `[in] env`: The environment in which to create the `Napi::CallbackScope`.
-- `[in] scope`: The pre-existing `napi_callback_scope` or `Napi::CallbackScope`.
-
-### Constructor
-
-Creates a new callback scope on the stack.
-
-```cpp
-Napi::CallbackScope::CallbackScope(napi_env env, napi_async_context context);
-```
-
-- `[in] env`: The environment in which to create the `Napi::CallbackScope`.
-- `[in] async_context`: The pre-existing `napi_async_context` or `Napi::AsyncContext`.
-
-### Destructor
-
-Deletes the instance of `Napi::CallbackScope` object.
-
-```cpp
-virtual Napi::CallbackScope::~CallbackScope();
-```
-
-### Env
-
-```cpp
-Napi::Env Napi::CallbackScope::Env() const;
-```
-
-Returns the `Napi::Env` associated with the `Napi::CallbackScope`.
-
-## Operator
-
-```cpp
-Napi::CallbackScope::operator napi_callback_scope() const;
-```
-
-Returns the Node-API `napi_callback_scope` wrapped by the `Napi::CallbackScope`
-object. This can be used to mix usage of the C Node-API and node-addon-api.