node-addon-api 2.0.2 → 3.1.0

package/doc/name.md

@@ -0,0 +1,29 @@
+# Name
+
+Class `Napi::Name` inherits from class [`Napi::Value`][].
+
+Names are JavaScript values that can be used as a property name. There are two
+specialized types of names supported in Node.js Addon API [`Napi::String`](string.md)
+and [`Napi::Symbol`](symbol.md).
+
+## Methods
+
+### Constructor
+```cpp
+Napi::Name::Name();
+```
+
+Returns an empty `Napi::Name`.
+
+```cpp
+Napi::Name::Name(napi_env env, napi_value value);
+```
+- `[in] env` - The environment in which to create the array.
+- `[in] value` - The primitive to wrap.
+
+Returns a `Napi::Name` created from the JavaScript primitive.
+
+Note:
+The value is not coerced to a string.
+
+[`Napi::Value`]: ./value.md

package/doc/number.md

@@ -16,7 +16,7 @@ Napi::Number();
 
 Returns a new _empty_ `Napi::Number` object.
 
-### Contructor
+### Constructor
 
 Creates a new instance of a `Napi::Number` object.
 

package/doc/object.md

@@ -1,8 +1,10 @@
 # Object
 
+Class `Napi::Object` inherits from class [`Napi::Value`][].
+
 The `Napi::Object` class corresponds to a JavaScript object. It is extended by the following node-addon-api classes that you may use when working with more specific types:
 
-- [`Napi::Value`](value.md) and extends [`Napi::Array`](array.md)
+- [`Napi::Array`](array.md)
 - [`Napi::ArrayBuffer`](array_buffer.md)
 - [`Napi::Buffer<T>`](buffer.md)
 - [`Napi::Function`](function.md)
@@ -101,6 +103,22 @@ While the value must be any of the following types:
 - `bool`
 - `double`
 
+### Delete()
+
+```cpp
+bool Napi::Object::Delete(____ key);
+```
+- `[in] key`: The name of the property to delete.
+
+Deletes the property associated with the given key. Returns `true` if the property was deleted.
+
+The `key` can be any of the following types:
+- `napi_value`
+- [`Napi::Value`](value.md)
+- `const char *`
+- `const std::string &`
+- `uint32_t`
+
 ### Get()
 
 ```cpp
@@ -171,6 +189,29 @@ void finalizeCallback(Napi::Env env, T* data, Hint* hint);
 ```
 where `data` and `hint` are the pointers that were passed into the call to `AddFinalizer()`.
 
+### GetPropertyNames()
+```cpp
+Napi::Array Napi::Object::GetPropertyNames() const;
+```
+
+Returns the names of the enumerable properties of the object as a [`Napi::Array`](array.md) of strings.
+The properties whose key is a `Symbol` will not be included.
+
+### HasOwnProperty()
+```cpp
+bool Napi::Object::HasOwnProperty(____ key); const
+```
+- `[in] key` The name of the property to check.
+
+Returns a `bool` that is *true* if the object has an own property named `key` and *false* otherwise.
+
+The key can be any of the following types:
+- `napi_value`
+- [`Napi::Value`](value.md)
+- `const char*`
+- `const std::string&`
+- `uint32_t`
+
 ### DefineProperty()
 
 ```cpp
@@ -234,3 +275,5 @@ Napi::Value Napi::Object::operator[] (uint32_t index) const;
 - `[in] index`: Element index.
 
 Returns an indexed property or array element as a [`Napi::Value`](value.md).
+
+[`Napi::Value`]: ./value.md

package/doc/object_lifetime_management.md

@@ -60,7 +60,7 @@ a native method must be deleted before returning from that method. Since
 deletion, however, care must be taken to create the scope in the right
 place such that you achieve the desired lifetime.
 
-Taking the earlier example, creating a `Napi::HandleScope` in the innner loop
+Taking the earlier example, creating a `Napi::HandleScope` in the inner loop
 would ensure that at most a single new value is held alive throughout the
 execution of the loop:
 
@@ -69,7 +69,7 @@ for (int i = 0; i < LOOP_MAX; i++) {
   Napi::HandleScope scope(info.Env());
   std::string name = std::string("inner-scope") + std::to_string(i);
   Napi::Value newValue = Napi::String::New(info.Env(), name.c_str());
-  // do something with neValue
+  // do something with newValue
 };
 ```
 

package/doc/object_reference.md

@@ -8,7 +8,7 @@ For more general information on references, please consult [`Napi::Reference`](r
 ```cpp
 #include <napi.h>
 
-using namescape Napi;
+using namespace Napi;
 
 void Init(Env env) {