node-addon-api 3.0.1 → 3.2.1

package/doc/typed_array_of.md

@@ -1,133 +0,0 @@
-# TypedArrayOf
-
-The `Napi::TypedArrayOf` class corresponds to the various
-[JavaScript `TypedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)
-classes.
-
-## Typedefs
-
-The common JavaScript `TypedArray` types are pre-defined for each of use:
-
-```cpp
-typedef Napi::TypedArrayOf<int8_t> Int8Array;
-typedef Napi::TypedArrayOf<uint8_t> Uint8Array;
-typedef Napi::TypedArrayOf<int16_t> Int16Array;
-typedef Napi::TypedArrayOf<uint16_t> Uint16Array;
-typedef Napi::TypedArrayOf<int32_t> Int32Array;
-typedef Napi::TypedArrayOf<uint32_t> Uint32Array;
-typedef Napi::TypedArrayOf<float> Float32Array;
-typedef Napi::TypedArrayOf<double> Float64Array;
-```
-
-The one exception is the `Uint8ClampedArray` which requires explicit
-initialization:
-
-```cpp
-Uint8Array::New(env, length, napi_uint8_clamped_array)
-```
-
-Note that while it's possible to create a "clamped" array the _clamping_
-behavior is only applied in JavaScript.
-
-## Methods
-
-### New
-
-Allocates a new `Napi::TypedArray` instance with a given length. The underlying
-`Napi::ArrayBuffer` is allocated automatically to the desired number of elements.
-
-The array type parameter can normally be omitted (because it is inferred from
-the template parameter T), except when creating a "clamped" array.
-
-```cpp
-static Napi::TypedArrayOf Napi::TypedArrayOf::New(napi_env env,
-                        size_t elementLength,
-                        napi_typedarray_type type);
-```
-
-- `[in] env`: The environment in which to create the `Napi::TypedArrayOf` instance.
-- `[in] elementLength`: The length to be allocated, in elements.
-- `[in] type`: The type of array to allocate (optional).
-
-Returns a new `Napi::TypedArrayOf` instance.
-
-### New
-
-Wraps the provided `Napi::ArrayBuffer` into a new `Napi::TypedArray` instance.
-
-The array `type` parameter can normally be omitted (because it is inferred from
-the template parameter `T`), except when creating a "clamped" array.
-
-```cpp
-static Napi::TypedArrayOf Napi::TypedArrayOf::New(napi_env env,
-                        size_t elementLength,
-                        Napi::ArrayBuffer arrayBuffer,
-                        size_t bufferOffset,
-                        napi_typedarray_type type);
-```
-
-- `[in] env`: The environment in which to create the `Napi::TypedArrayOf` instance.
-- `[in] elementLength`: The length to array, in elements.
-- `[in] arrayBuffer`: The backing `Napi::ArrayBuffer` instance.
-- `[in] bufferOffset`: The offset into the `Napi::ArrayBuffer` where the array starts,
-                       in bytes.
-- `[in] type`: The type of array to allocate (optional).
-
-Returns a new `Napi::TypedArrayOf` instance.
-
-### Constructor
-
-Initializes an empty instance of the `Napi::TypedArrayOf` class.
-
-```cpp
-Napi::TypedArrayOf::TypedArrayOf();
-```
-
-### Constructor
-
-Initializes a wrapper instance of an existing `Napi::TypedArrayOf` object.
-
-```cpp
-Napi::TypedArrayOf::TypedArrayOf(napi_env env, napi_value value);
-```
-
-- `[in] env`: The environment in which to create the `Napi::TypedArrayOf` object.
-- `[in] value`: The `Napi::TypedArrayOf` reference to wrap.
-
-### operator []
-
-```cpp
-T& Napi::TypedArrayOf::operator [](size_t index);
-```
-
-- `[in] index: The element index into the array.
-
-Returns the element found at the given index.
-
-### operator []
-
-```cpp
-const T& Napi::TypedArrayOf::operator [](size_t index) const;
-```
-
-- `[in] index: The element index into the array.
-
-Returns the element found at the given index.
-
-### Data
-
-```cpp
-T* Napi::TypedArrayOf::Data() const;
-```
-
-Returns a pointer into the backing `Napi::ArrayBuffer` which is offset to point to the
-start of the array.
-
-### Data
-
-```cpp
-const T* Napi::TypedArrayOf::Data() const
-```
-
-Returns a pointer into the backing `Napi::ArrayBuffer` which is offset to point to the
-start of the array.

package/doc/value.md

@@ -1,278 +0,0 @@
-# Value
-
-`Napi::Value` is the C++ manifestation of a JavaScript value.
-
-Value is a the base class upon which other JavaScript values such as Number, Boolean, String, and Object are based.
-
-The following classes inherit, either directly or indirectly, from `Napi::Value`:
-
-- [`Napi::Array`](basic_types.md#array)
-- [`Napi::ArrayBuffer`](array_buffer.md)
-- [`Napi::Boolean`](boolean.md)
-- [`Napi::Buffer`](buffer.md)
-- [`Napi::Date`](date.md)
-- [`Napi::External`](external.md)
-- [`Napi::Function`](function.md)
-- [`Napi::Name`](name.md)
-- [`Napi::Number`](number.md)
-- [`Napi::Object`](object.md)
-- [`Napi::String`](string.md)
-- [`Napi::Symbol`](symbol.md)
-- [`Napi::TypedArray`](typed_array.md)
-- [`Napi::TypedArrayOf`](typed_array_of.md)
-
-## Methods
-
-### Empty Constructor
-
-```cpp
-Napi::Value::Value();
-```
-
-Creates a new *empty* `Napi::Value` instance.
-
-### Constructor
-
-```cpp
-Napi::Value::Value(napi_env env, napi_value value);
-```
-
-- `[in] env`: The `napi_env` environment in which to construct the `Napi::Value` object.
-
-- `[in] value`: The C++ primitive from which to instantiate the `Napi::Value`. `value` may be any of:
-  - `bool`
-  - Any integer type
-  - Any floating point type
-  - `const char*` (encoded using UTF-8, null-terminated)
-  - `const char16_t*` (encoded using UTF-16-LE, null-terminated)
-  - `std::string` (encoded using UTF-8)
-  - `std::u16string`
-  - `Napi::Value`
-  - `napi_value`
-
-### From
-
-```cpp
-template <typename T> static Napi::Value Napi::Value::From(napi_env env, const T& value);
-```
-
-- `[in] env`: The `napi_env` environment in which to create the `Napi::Value` object.
-
-- `[in] value`: The N-API primitive value from which to create the `Napi::Value` object.
-
-Returns a `Napi::Value` object from an N-API primitive value.
-
-### operator napi_value
-
-```cpp
-operator napi_value() const;
-```
-
-Returns this Value's N-API value primitive.
-
-Returns `nullptr` if this `Napi::Value` is *empty*.
-
-### operator ==
-
-```cpp
-
-bool Napi::Value::operator ==(const Napi::Value& other) const;
-```
-
-- `[in] other`: The `Napi::Value` object to be compared.
-
-Returns a `bool` indicating if this `Napi::Value` strictly equals another `Napi::Value`.
-
-### operator !=
-
-```cpp
-bool Napi::Value::operator !=(const Napi::Value& other) const;
-```
-
-- `[in] other`: The `Napi::Value` object to be compared.
-
-Returns a `bool` indicating if this `Napi::Value` does not strictly equal another `Napi::Value`.
-
-### StrictEquals
-
-```cpp
-bool Napi::Value::StrictEquals(const Napi::Value& other) const;
-```
-- `[in] other`: The `Napi::Value` object to be compared.
-
-Returns a `bool` indicating if this `Napi::Value` strictly equals another `Napi::Value`.
-
-### Env
-
-```cpp
-Napi::Env Napi::Value::Env() const;
-```
-
-Returns the `Napi::Env` environment this value is associated with.
-
-### IsEmpty
-
-```cpp
-bool Napi::Value::IsEmpty() const;
-```
-
-Returns a `bool` indicating if this `Napi::Value` is *empty* (uninitialized).
-
-An empty `Napi::Value` is invalid, and most attempts to perform an operation on an empty Value will result in an exception.
-Note an empty `Napi::Value` is distinct from JavaScript `null` or `undefined`, which are valid values.
-
-When C++ exceptions are disabled at compile time, a method with a `Napi::Value` return type may return an empty Value to indicate a pending exception. So when not using C++ exceptions, callers should check whether this `Napi::Value` is empty before attempting to use it.
-
-### Type
-
-```cpp
-napi_valuetype Napi::Value::Type() const;
-```
-
-Returns the `napi_valuetype` type of the `Napi::Value`.
-
-### IsUndefined
-
-```cpp
-bool Napi::Value::IsUndefined() const;
-```
-
-Returns a `bool` indicating if this `Napi::Value` is an undefined JavaScript value.
-
-### IsNull
-
-```cpp
-bool Napi::Value::IsNull() const;
-```
-
-Returns a `bool` indicating if this `Napi::Value` is a null JavaScript value.
-
-### IsBoolean
-
-```cpp
-bool Napi::Value::IsBoolean() const;
-```
-
-Returns a `bool` indicating if this `Napi::Value` is a JavaScript boolean.
-
-### IsNumber
-
-```cpp
-bool Napi::Value::IsNumber() const;
-```
-
-Returns a `bool` indicating if this `Napi::Value` is a JavaScript number.
-
-### IsString
-
-```cpp
-bool Napi::Value::IsString() const;
-```
-
-Returns a `bool` indicating if this `Napi::Value` is a JavaScript string.
-
-### IsSymbol
-
-```cpp
-bool Napi::Value::IsSymbol() const;
-```
-
-Returns a `bool` indicating if this `Napi::Value` is a JavaScript symbol.
-
-### IsArray
-
-```cpp
-bool Napi::Value::IsArray() const;
-```
-
-Returns a `bool` indicating if this `Napi::Value` is a JavaScript array.
-
-### IsArrayBuffer
-
-```cpp
-bool Napi::Value::IsArrayBuffer() const;
-```
-
-Returns a `bool` indicating if this `Napi::Value` is a JavaScript array buffer.
-
-### IsTypedArray
-
-```cpp
-bool Napi::Value::IsTypedArray() const;
-```
-
-Returns a `bool` indicating if this `Napi::Value` is a JavaScript typed array.
-
-### IsObject
-
-```cpp
-bool Napi::Value::IsObject() const;
-```
-
-Returns a `bool` indicating if this `Napi::Value` is JavaScript object.
-
-### IsFunction
-
-```cpp
-bool Napi::Value::IsFunction() const;
-```
-
-Returns a `bool` indicating if this `Napi::Value` is a JavaScript function.
-
-### IsBuffer
-
-```cpp
-bool Napi::Value::IsBuffer() const;
-```
-
-Returns a `bool` indicating if this `Napi::Value` is a Node buffer.
-
-### IsDate
-
-```cpp
-bool Napi::Value::IsDate() const;
-```
-
-Returns a `bool` indicating if this `Napi::Value` is a JavaScript date.
-
-### As
-
-```cpp
-template <typename T> T Napi::Value::As() const;
-```
-
-Casts to another type of `Napi::Value`, when the actual type is known or assumed.
-
-This conversion does not coerce the type. Calling any methods inappropriate for the actual value type will throw `Napi::Error`.
-
-### ToBoolean
-
-```cpp
-Napi::Boolean Napi::Value::ToBoolean() const;
-```
-
-Returns the `Napi::Value` coerced to a JavaScript boolean.
-
-### ToNumber
-
-```cpp
-Napi::Number Napi::Value::ToNumber() const;
-```
-
-Returns the `Napi::Value` coerced to a JavaScript number.
-
-### ToString
-
-```cpp
-Napi::String Napi::Value::ToString() const;
-```
-
-Returns the `Napi::Value` coerced to a JavaScript string.
-
-### ToObject
-
-```cpp
-Napi::Object Napi::Value::ToObject() const;
-```
-
-Returns the `Napi::Value` coerced to a JavaScript object.

package/doc/version_management.md

@@ -1,43 +0,0 @@
-# VersionManagement
-
-The `Napi::VersionManagement` class contains methods that allow information
-to be retrieved about the version of N-API and Node.js. In some cases it is
-important to make decisions based on different versions of the system.
-
-## Methods
-
-### GetNapiVersion
-
-Retrieves the highest N-API version supported by Node.js runtime.
-
-```cpp
-static uint32_t Napi::VersionManagement::GetNapiVersion(Env env);
-```
-
-- `[in] env`: The environment in which the API is invoked under.
-
-Returns the highest N-API version supported by Node.js runtime.
-
-### GetNodeVersion
-
-Retrives information about Node.js version present on the system. All the
-information is stored in the `napi_node_version` structrue that is defined as
-shown below:
-
-```cpp
-typedef struct {
-  uint32_t major;
-  uint32_t minor;
-  uint32_t patch;
-  const char* release;
-} napi_node_version;
-````
-
-```cpp
-static const napi_node_version* Napi::VersionManagement::GetNodeVersion(Env env);
-```
-
-- `[in] env`: The environment in which the API is invoked under.
-
-Returns the structure a pointer to the structure `napi_node_version` populated by
-the version information of Node.js runtime.

package/doc/working_with_javascript_values.md

@@ -1,14 +0,0 @@
-# Working with JavaScript Values
-
-`node-addon-api` provides a set of classes that allow to create and manage
-JavaScript object:
-
-- [Function](function.md)
-  - [FunctionReference](function_reference.md)
-- [ObjectWrap](object_wrap.md)
-  - [ClassPropertyDescriptor](class_property_descriptor.md)
-- [Buffer](buffer.md)
-- [ArrayBuffer](array_buffer.md)
-- [TypedArray](typed_array.md)
-  - [TypedArrayOf](typed_array_of.md)
-- [DataView](dataview.md)