harperdb 3.2.1 → 3.3.0

package/node_modules/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 N-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 N-API `napi_callback_scope` wrapped by the `Napi::CallbackScope`
-object. This can be used to mix usage of the C N-API and node-addon-api.

package/node_modules/node-addon-api/doc/callbackinfo.md

@@ -1,97 +0,0 @@
-# CallbackInfo
-
-The object representing the components of the JavaScript request being made.
-
-The `Napi::CallbackInfo` object is usually created and passed by the Node.js runtime or node-addon-api infrastructure.
-
-The `Napi::CallbackInfo` object contains the arguments passed by the caller. The number of arguments is returned by the `Length` method. Each individual argument can be accessed using the `operator[]` method.
-
-The `SetData` and `Data` methods are used to set and retrieve the data pointer contained in the `Napi::CallbackInfo` object.
-
-## Methods
-
-### Constructor
-
-```cpp
-Napi::CallbackInfo::CallbackInfo(napi_env env, napi_callback_info info);
-```
-
-- `[in] env`: The `napi_env` environment in which to construct the `Napi::CallbackInfo` object.
-- `[in] info`: The `napi_callback_info` data structure from which to construct the `Napi::CallbackInfo` object.
-
-### Env
-
-```cpp
-Napi::Env Napi::CallbackInfo::Env() const;
-```
-
-Returns the `Env` object in which the request is being made.
-
-### NewTarget
-
-```cpp
-Napi::Value Napi::CallbackInfo::NewTarget() const;
-```
-
-Returns the `new.target` value of the constructor call. If the function that was invoked (and for which the `Napi::NCallbackInfo` was passed) is not a constructor call, a call to `IsEmpty()` on the returned value returns true.
-
-### IsConstructCall
-
-```cpp
-bool Napi::CallbackInfo::IsConstructCall() const;
-```
-
-Returns a `bool` indicating if the function that was invoked (and for which the `Napi::CallbackInfo` was passed) is a constructor call.
-
-### Length
-
-```cpp
-size_t Napi::CallbackInfo::Length() const;
-```
-
-Returns the number of arguments passed in the `Napi::CallbackInfo` object.
-
-### operator []
-
-```cpp
-const Napi::Value operator [](size_t index) const;
-```
-
-- `[in] index`: The zero-based index of the requested argument.
-
-Returns a `Napi::Value` object containing the requested argument.
-
-### This
-
-```cpp
-Napi::Value Napi::CallbackInfo::This() const;
-```
-
-Returns the JavaScript `this` value for the call
-
-### Data
-
-```cpp
-void* Napi::CallbackInfo::Data() const;
-```
-
-Returns the data pointer for the callback.
-
-### SetData
-
-```cpp
-void Napi::CallbackInfo::SetData(void* data);
-```
-
-- `[in] data`: The new data pointer to associate with this `Napi::CallbackInfo` object.
-
-Returns `void`.
-
-### Not documented here
-
-```cpp
-Napi::CallbackInfo::~CallbackInfo();
-// Disallow copying to prevent multiple free of _dynamicArgs
-Napi::CallbackInfo::CallbackInfo(CallbackInfo const &) = delete;
-void Napi::CallbackInfo::operator=(CallbackInfo const &) = delete;
-```

package/node_modules/node-addon-api/doc/checker-tool.md

@@ -1,32 +0,0 @@
-# Checker Tool
-
-**node-addon-api** provides a [checker tool][] that will inspect a given
-directory tree, identifying all Node.js native addons therein, and further
-indicating for each addon whether it is an N-API addon.
-
-## To use the checker tool:
-
-  1. Install the application with `npm install`.
-
-  2. If the application does not depend on **node-addon-api**, copy the
-     checker tool into the application's directory.
-
-  3. If the application does not depend on **node-addon-api**, run the checker
-     tool from the application's directory:
-
-     ```sh
-     node ./check-napi.js
-     ```
-
-     Otherwise, the checker tool can be run from the application's
-     `node_modules/` subdirectory:
-
-     ```sh
-     node ./node_modules/node-addon-api/tools/check-napi.js
-     ```
-
-The tool accepts the root directory from which to start checking for Node.js
-native addons as a single optional command line parameter. If ommitted it will
-start checking from the current directory (`.`).
-
-[checker tool]: ../tools/check-napi.js

package/node_modules/node-addon-api/doc/class_property_descriptor.md

@@ -1,118 +0,0 @@
-# Class property and descriptor
-
-Property descriptor for use with `Napi::ObjectWrap::DefineClass()`.
-This is different from the standalone `Napi::PropertyDescriptor` because it is
-specific to each `Napi::ObjectWrap<T>` subclass.
-This prevents using descriptors from a different class when defining a new class
-(preventing the callbacks from having incorrect `this` pointers).
-
-## Example
-
-```cpp
-#include <napi.h>
-
-class Example : public Napi::ObjectWrap<Example> {
-  public:
-    static Napi::Object Init(Napi::Env env, Napi::Object exports);
-    Example(const Napi::CallbackInfo &info);
-
-  private:
-    static Napi::FunctionReference constructor;
-    double _value;
-    Napi::Value GetValue(const Napi::CallbackInfo &info);
-    Napi::Value SetValue(const Napi::CallbackInfo &info);
-};
-
-Napi::Object Example::Init(Napi::Env env, Napi::Object exports) {
-    Napi::Function func = DefineClass(env, "Example", {
-        // Register a class instance accessor with getter and setter functions.
-        InstanceAccessor("value", &Example::GetValue, &Example::SetValue),
-        // We can also register a readonly accessor by passing nullptr as the setter.
-        InstanceAccessor("readOnlyProp", &Example::GetValue, nullptr)
-    });
-
-    constructor = Napi::Persistent(func);
-    constructor.SuppressDestruct();
-    exports.Set("Example", func);
-
-    return exports;
-}
-
-Example::Example(const Napi::CallbackInfo &info) : Napi::ObjectWrap<Example>(info) {
-    Napi::Env env = info.Env();
-    // ...
-    Napi::Number value = info[0].As<Napi::Number>();
-    this->_value = value.DoubleValue();
-}
-
-Napi::FunctionReference Example::constructor;
-
-Napi::Value Example::GetValue(const Napi::CallbackInfo &info) {
-    Napi::Env env = info.Env();
-    return Napi::Number::New(env, this->_value);
-}
-
-Napi::Value Example::SetValue(const Napi::CallbackInfo &info, const Napi::Value &value) {
-    Napi::Env env = info.Env();
-    // ...
-    Napi::Number arg = value.As<Napi::Number>();
-    this->_value = arg.DoubleValue();
-    return this->GetValue(info);
-}
-
-// Initialize native add-on
-Napi::Object Init (Napi::Env env, Napi::Object exports) {
-    Example::Init(env, exports);
-    return exports;
-}
-
-// Register and initialize native add-on
-NODE_API_MODULE(NODE_GYP_MODULE_NAME, Init)
-```
-
-The above code can be used from JavaScript as follows:
-
-```js
-'use strict';
-
-const { Example } = require('bindings')('addon');
-
-const example = new Example(11);
-console.log(example.value);
-// It prints 11
-example.value = 19;
-console.log(example.value);
-// It prints 19
-example.readOnlyProp = 500;
-console.log(example.readOnlyProp);
-// Unchanged. It prints 19
-```
-
-## Methods
-
-### Constructor
-
-Creates new instance of `Napi::ClassPropertyDescriptor` descriptor object.
-
-```cpp
-Napi::ClassPropertyDescriptor(napi_property_descriptor desc) : _desc(desc) {}
-```
-
-- `[in] desc`: The `napi_property_descriptor`
-
-Returns new instance of `Napi::ClassPropertyDescriptor` that is used as property descriptor
-inside the `Napi::ObjectWrap<T>` class.
-
-### Operator
-
-```cpp
-operator napi_property_descriptor&() { return _desc; }
-```
-
-Returns the original N-API `napi_property_descriptor` wrapped inside the `Napi::ClassPropertyDescriptor`
-
-```cpp
-operator const napi_property_descriptor&() const { return _desc; }
-```
-
-Returns the original N-API `napi_property_descriptor` wrapped inside the `Napi::ClassPropertyDescriptor`

package/node_modules/node-addon-api/doc/cmake-js.md

@@ -1,19 +0,0 @@
-# CMake.js
-
-**CMake.js** is a build tool that allow native addon developer to compile their
-C++ code into executable form. It works like **[node-gyp](node-gyp.md)** but
-instead of Google's **gyp** format it is base on **CMake** build system.
-
-## **CMake** reference
-
-  - [Installation](https://www.npmjs.com/package/cmake-js#installation)
-  - [How to use](https://www.npmjs.com/package/cmake-js#usage)
-  - [Using N-API and node-addon-api](https://github.com/cmake-js/cmake-js#n-api-and-node-addon-api)
-  - [Tutorials](https://www.npmjs.com/package/cmake-js#tutorials)
-  - [Use case in the works - ArrayFire.js](https://www.npmjs.com/package/cmake-js#use-case-in-the-works---arrayfirejs)
-
-Sometimes finding the right settings is not easy so to accomplish at most
-complicated task please refer to:
-
-- [CMake documentation](https://cmake.org/)
-- [CMake.js wiki](https://github.com/cmake-js/cmake-js/wiki)

package/node_modules/node-addon-api/doc/conversion-tool.md

@@ -1,28 +0,0 @@
-# Conversion Tool
-
-To make the migration to **node-addon-api** easier, we have provided a script to
-help complete some tasks.
-
-## To use the conversion script:
-
-  1. Go to your module directory
-
-```
-cd [module_path]
-```
-
-  2. Install node-addon-api module
-
-```
-npm install node-addon-api
-```
-  3. Run node-addon-api conversion script
-
-```
-node ./node_modules/node-addon-api/tools/conversion.js ./
-```
-
-  4. While this script makes conversion easier, it still cannot fully convert
-the module. The next step is to try to build the module and complete the
-remaining conversions necessary to allow it to compile and pass all of the
-module's tests.

package/node_modules/node-addon-api/doc/creating_a_release.md

@@ -1,62 +0,0 @@
-# Creating a release
-
-Only collaborators in npm for **node-addon-api** can create releases.
-If you want to be able to do releases ask one of the existing
-collaborators to add you. If necessary you can ask the build
-Working Group who manages the Node.js npm user to add you if
-there are no other active collaborators.
-
-## Prerequisites
-
-Before to start creating a new release check if you have installed the following
-tools:
-
-* [Changelog maker](https://www.npmjs.com/package/changelog-maker)
-
-If not please follow the instruction reported in the tool's documentation to 
-install it.
-
-## Publish new release
-
-These are the steps to follow to create a new release:
-
-* Open an issue in the **node-addon-api** repo documenting the intent to create a
-new release. Give people some time to comment or suggest PRs that should land first.
-
-* Validate all tests pass by running npm test on master.
-
-* Update the version in **package.json** appropriately.
-
-* Update the [README.md](https://github.com/nodejs/node-addon-api/blob/master/README.md) 
-to show the new version as the latest.
-
-* Generate the changelog for the new version using **changelog maker** tool. From
-the route folder of the repo launch the following command:
-
-    ```bash 
-    > changelog-maker
-    ```
-* Use the output generated by **changelog maker** to pdate the [CHANGELOG.md](https://github.com/nodejs/node-addon-api/blob/master/CHANGELOG.md)
-following the style used in publishing the previous release.
-
-* Add any new contributors to the "contributors" section in the package.json
-
-* Validate all tests pass by running npm test on master.
-
-* Use **[CI](https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api/)**
-to validate tests pass for latest 11, 10, 8, 6 releases (note there are still some issues on SmartOS and
-Windows in the testing).
-
-* Do a clean checkout of node-addon-api.
-
-* Login and then run `npm publish`.
-
-* Create a release in Github (look at existing releases for an example).
-
-* Validate that you can run `npm install node-addon-api` successfully
-and that the correct version is installed.
-
-* Comment on the issue opened in the first step that the release has been created
-and close the issue.
-
-* Tweet that the release has been created.

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

@@ -1,244 +0,0 @@
-# DataView
-
-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.