node-addon-api 2.0.2 → 3.1.0

package/doc/function.md

@@ -11,6 +11,10 @@ functions that were created in JavaScript and passed to the native add-on.
 The `Napi::Function` class inherits its behavior from the `Napi::Object` class (for more info
 see: [`Napi::Object`](object.md)).
 
+> For callbacks that will be called with asynchronous events from a
+> non-JavaScript thread, please refer to [`Napi::ThreadSafeFunction`][] for more
+> examples.
+
 ## Example
 
 ```cpp
@@ -25,7 +29,8 @@ Value Fn(const CallbackInfo& info) {
 }
 
 Object Init(Env env, Object exports) {
-  exports.Set(String::New(env, "fn"), Function::New(env, Fn));
+  exports.Set(String::New(env, "fn"), Function::New<Fn>(env));
+  return exports;
 }
 
 NODE_API_MODULE(NODE_GYP_MODULE_NAME, Init)
@@ -47,6 +52,27 @@ and in general in situations which don't have an existing JavaScript function on
 the stack. The `Call` method is used when there is already a JavaScript function
 on the stack (for example when running a native method called from JavaScript).
 
+## Type definitions
+
+### Napi::Function::VoidCallback
+
+This is the type describing a callback returning `void` that will be invoked
+from JavaScript.
+
+```cpp
+typedef void (*VoidCallback)(const Napi::CallbackInfo& info);
+```
+
+### Napi::Function::Callback
+
+This is the type describing a callback returning a value that will be invoked
+from JavaScript.
+
+
+```cpp
+typedef Value (*Callback)(const Napi::CallbackInfo& info);
+```
+
 ## Methods
 
 ### Constructor
@@ -74,6 +100,86 @@ Returns a non-empty `Napi::Function` instance.
 
 Creates an instance of a `Napi::Function` object.
 
+```cpp
+template <Napi::VoidCallback cb>
+static Napi::Function New(napi_env env,
+                          const char* utf8name = nullptr,
+                          void* data = nullptr);
+```
+
+- `[template] cb`: The native function to invoke when the JavaScript function is
+invoked.
+- `[in] env`: The `napi_env` environment in which to construct the `Napi::Function` object.
+- `[in] utf8name`: Null-terminated string to be used as the name of the function.
+- `[in] data`: User-provided data context. This will be passed back into the
+function when invoked later.
+
+Returns an instance of a `Napi::Function` object.
+
+### New
+
+Creates an instance of a `Napi::Function` object.
+
+```cpp
+template <Napi::Callback cb>
+static Napi::Function New(napi_env env,
+                          const char* utf8name = nullptr,
+                          void* data = nullptr);
+```
+
+- `[template] cb`: The native function to invoke when the JavaScript function is
+invoked.
+- `[in] env`: The `napi_env` environment in which to construct the `Napi::Function` object.
+- `[in] utf8name`: Null-terminated string to be used as the name of the function.
+- `[in] data`: User-provided data context. This will be passed back into the
+function when invoked later.
+
+Returns an instance of a `Napi::Function` object.
+
+### New
+
+Creates an instance of a `Napi::Function` object.
+
+```cpp
+template <Napi::VoidCallback cb>
+static Napi::Function New(napi_env env,
+                          const std::string& utf8name,
+                          void* data = nullptr);
+```
+
+- `[template] cb`: The native function to invoke when the JavaScript function is
+invoked.
+- `[in] env`: The `napi_env` environment in which to construct the `Napi::Function` object.
+- `[in] utf8name`: String to be used as the name of the function.
+- `[in] data`: User-provided data context. This will be passed back into the
+function when invoked later.
+
+Returns an instance of a `Napi::Function` object.
+
+### New
+
+Creates an instance of a `Napi::Function` object.
+
+```cpp
+template <Napi::Callback cb>
+static Napi::Function New(napi_env env,
+                          const std::string& utf8name,
+                          void* data = nullptr);
+```
+
+- `[template] cb`: The native function to invoke when the JavaScript function is
+invoked.
+- `[in] env`: The `napi_env` environment in which to construct the `Napi::Function` object.
+- `[in] utf8name`: String to be used as the name of the function.
+- `[in] data`: User-provided data context. This will be passed back into the
+function when invoked later.
+
+Returns an instance of a `Napi::Function` object.
+
+### New
+
+Creates an instance of a `Napi::Function` object.
+
 ```cpp
 template <typename Callable>
 static Napi::Function Napi::Function::New(napi_env env, Callable cb, const char* utf8name = nullptr, void* data = nullptr);
@@ -112,7 +218,7 @@ Napi::Object Napi::Function::New(const std::initializer_list<napi_value>& args)
 ```
 
 - `[in] args`: Initializer list of JavaScript values as `napi_value` representing
-the arguments of the contructor function.
+the arguments of the constructor function.
 
 Returns a new JavaScript object.
 
@@ -139,7 +245,7 @@ object.
 Napi::Object Napi::Function::New(size_t argc, const napi_value* args) const;
 ```
 
-- `[in] argc`: The number of the arguments passed to the contructor function.
+- `[in] argc`: The number of the arguments passed to the constructor function.
 - `[in] args`: Array of JavaScript values as `napi_value` representing the
 arguments of the constructor function.
 
@@ -292,3 +398,5 @@ Napi::Value Napi::Function::operator ()(const std::initializer_list<napi_value>&
 - `[in] args`: Initializer list of JavaScript values as `napi_value`.
 
 Returns a `Napi::Value` representing the JavaScript value returned by the function.
+
+[`Napi::ThreadSafeFunction`]: ./threadsafe_function.md

package/doc/function_reference.md

@@ -73,7 +73,7 @@ Napi::Object Napi::FunctionReference::New(const std::initializer_list<napi_value
 ```
 
 - `[in] args`: Initializer list of JavaScript values as `napi_value` representing
-the arguments of the contructor function.
+the arguments of the constructor function.
 
 Returns a new JavaScript object.
 

package/doc/handle_scope.md

@@ -54,7 +54,7 @@ Napi::HandleScope::~HandleScope();
 
 Deletes the `Napi::HandleScope` instance and allows any objects/handles created
 in the scope to be collected by the garbage collector.  There is no
-guarantee as to when the gargbage collector will do this.
+guarantee as to when the garbage collector will do this.
 
 ### Env
 

package/doc/hierarchy.md

@@ -0,0 +1,91 @@
+# Full Class Hierarchy
+
+| Class | Parent Class(es) |
+|---|---|
+| [`Napi::Addon`][] | [`Napi::InstanceWrap`][] |
+| [`Napi::Array`][] | [`Napi::Object`][] |
+| [`Napi::ArrayBuffer`][] | [`Napi::Object`][] |
+| [`Napi::AsyncContext`][] |  |
+| [`Napi::AsyncProgressQueueWorker`][] | `Napi::AsyncProgressWorkerBase` |
+| [`Napi::AsyncProgressWorker`][] | `Napi::AsyncProgressWorkerBase` |
+| [`Napi::AsyncWorker`][] |  |
+| [`Napi::BigInt`][] | [`Napi::Value`][] |
+| [`Napi::Boolean`][] | [`Napi::Value`][] |
+| [`Napi::Buffer`][] | [`Napi::Uint8Array`][] |
+| [`Napi::CallbackInfo`][] |  |
+| [`Napi::CallbackScope`][] |  |
+| [`Napi::ClassPropertyDescriptor`][] |  |
+| [`Napi::DataView`][] | [`Napi::Object`][] |
+| [`Napi::Date`][] | [`Napi::Value`][] |
+| [`Napi::Env`][] |  |
+| [`Napi::Error`][] | [`Napi::ObjectReference`][], [`std::exception`][] |
+| [`Napi::EscapableHandleScope`][] |  |
+| [`Napi::External`][] | [`Napi::Value`][] |
+| [`Napi::Function`][] | [`Napi::Object`][] |
+| [`Napi::FunctionReference`][] | [`Napi::Reference<Napi::Function>`][] |
+| [`Napi::HandleScope`][] |  |
+| [`Napi::InstanceWrap`][] |  |
+| [`Napi::MemoryManagement`][] |  |
+| [`Napi::Name`][] | [`Napi::Value`][] |
+| [`Napi::Number`][] | [`Napi::Value`][] |
+| [`Napi::Object`][] | [`Napi::Value`][] |
+| [`Napi::ObjectReference`][] | [`Napi::Reference<Napi::Object>`][] |
+| [`Napi::ObjectWrap`][] | [`Napi::InstanceWrap`][], [`Napi::Reference<Napi::Object>`][] |
+| [`Napi::Promise`][] | [`Napi::Object`][] |
+| [`Napi::PropertyDescriptor`][] |  |
+| [`Napi::RangeError`][] | [`Napi::Error`][] |
+| [`Napi::Reference`] |  |
+| [`Napi::String`][] | [`Napi::Name`][] |
+| [`Napi::Symbol`][] | [`Napi::Name`][] |
+| [`Napi::ThreadSafeFunction`][] |  |
+| [`Napi::TypeError`][] | [`Napi::Error`][] |
+| [`Napi::TypedArray`][] | [`Napi::Object`][] |
+| [`Napi::TypedArrayOf`][] | [`Napi::TypedArray`][] |
+| [`Napi::Value`][] |  |
+| [`Napi::VersionManagement`][] |  |
+
+[`Napi::Addon`]: ./addon.md
+[`Napi::Array`]: ./array.md
+[`Napi::ArrayBuffer`]: ./array_buffer.md
+[`Napi::AsyncContext`]: ./async_context.md
+[`Napi::AsyncProgressQueueWorker`]: ./async_worker_variants.md#asyncprogressqueueworker
+[`Napi::AsyncProgressWorker`]: ./async_worker_variants.md#asyncprogressworker
+[`Napi::AsyncWorker`]: ./async_worker.md
+[`Napi::BigInt`]: ./bigint.md
+[`Napi::Boolean`]: ./boolean.md
+[`Napi::Buffer`]: ./buffer.md
+[`Napi::CallbackInfo`]: ./callbackinfo.md
+[`Napi::CallbackScope`]: ./callback_scope.md
+[`Napi::ClassPropertyDescriptor`]: ./class_property_descriptor.md
+[`Napi::DataView`]: ./dataview.md
+[`Napi::Date`]: ./date.md
+[`Napi::Env`]: ./env.md
+[`Napi::Error`]: ./error.md
+[`Napi::EscapableHandleScope`]: ./escapable_handle_scope.md
+[`Napi::External`]: ./external.md
+[`Napi::Function`]: ./function.md
+[`Napi::FunctionReference`]: ./function_reference.md
+[`Napi::HandleScope`]: ./handle_scope.md
+[`Napi::InstanceWrap`]: ./instance_wrap.md
+[`Napi::MemoryManagement`]: ./memory_management.md
+[`Napi::Name`]: ./name.md
+[`Napi::Number`]: ./number.md
+[`Napi::Object`]: ./object.md
+[`Napi::ObjectReference`]: ./object_reference.md
+[`Napi::ObjectWrap`]: ./object_wrap.md
+[`Napi::Promise`]: ./promise.md
+[`Napi::PropertyDescriptor`]: ./property_descriptor.md
+[`Napi::RangeError`]: ./range_error.md
+[`Napi::Reference`]: ./reference.md
+[`Napi::Reference<Napi::Function>`]: ./reference.md
+[`Napi::Reference<Napi::Object>`]: ./reference.md
+[`Napi::String`]: ./string.md
+[`Napi::Symbol`]: ./symbol.md
+[`Napi::ThreadSafeFunction`]: ./thread_safe_function.md
+[`Napi::TypeError`]: ./type_error.md
+[`Napi::TypedArray`]: ./typed_array.md
+[`Napi::TypedArrayOf`]: ./typed_array_of.md
+[`Napi::Uint8Array`]: ./typed_array_of.md
+[`Napi::Value`]: ./value.md
+[`Napi::VersionManagement`]: ./version_management.md
+[`std::exception`]: https://cplusplus.com/reference/exception/exception/

package/doc/instance_wrap.md

@@ -0,0 +1,408 @@
+# InstanceWrap<T>
+
+This class serves as the base class for [`Napi::ObjectWrap<T>`][] and
+[`Napi::Addon<T>`][].
+
+In the case of [`Napi::Addon<T>`][] it provides the
+methods for exposing functions to JavaScript on instances of an add-on.
+
+As a base class for [`Napi::ObjectWrap<T>`][] it provides the methods for
+exposing instance methods of JavaScript objects instantiated from the JavaScript
+class corresponding to the subclass of [`Napi::ObjectWrap<T>`][].
+
+## Methods
+
+### InstanceMethod
+
+Creates a property descriptor that represents a method exposed on JavaScript
+instances of this class.
+
+```cpp
+template <typename T>
+static Napi::ClassPropertyDescriptor<T>
+Napi::InstanceWrap<T>::InstanceMethod(const char* utf8name,
+                             InstanceVoidMethodCallback method,
+                             napi_property_attributes attributes = napi_default,
+                             void* data = nullptr);
+```
+
+- `[in] utf8name`: Null-terminated string that represents the name of the method
+provided by instances of the class.
+- `[in] method`: The native function that represents a method provided by the
+add-on.
+- `[in] attributes`: The attributes associated with the property. One or more of
+`napi_property_attributes`.
+- `[in] data`: User-provided data passed into the method when it is invoked.
+
+Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
+provided by instances of the class. The method must be of the form
+
+```cpp
+void MethodName(const Napi::CallbackInfo& info);
+```
+
+### InstanceMethod
+
+Creates a property descriptor that represents a method exposed on JavaScript
+instances of this class.
+
+```cpp
+template <typename T>
+static Napi::ClassPropertyDescriptor<T>
+Napi::InstanceWrap<T>::InstanceMethod(const char* utf8name,
+                             InstanceMethodCallback method,
+                             napi_property_attributes attributes = napi_default,
+                             void* data = nullptr);
+```
+
+- `[in] utf8name`: Null-terminated string that represents the name of the method
+provided by instances of the class.
+- `[in] method`: The native function that represents a method provided by the
+add-on.
+- `[in] attributes`: The attributes associated with the property. One or more of
+`napi_property_attributes`.
+- `[in] data`: User-provided data passed into the method when it is invoked.
+
+Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
+provided by instances of the class. The method must be of the form
+
+```cpp
+Napi::Value MethodName(const Napi::CallbackInfo& info);
+```
+
+### InstanceMethod
+
+Creates a property descriptor that represents a method exposed on JavaScript
+instances of this class.
+
+```cpp
+template <typename T>
+static Napi::ClassPropertyDescriptor<T>
+Napi::InstanceWrap<T>::InstanceMethod(Napi::Symbol name,
+                             InstanceVoidMethodCallback method,
+                             napi_property_attributes attributes = napi_default,
+                             void* data = nullptr);
+```
+
+- `[in] name`: JavaScript symbol that represents the name of the method provided
+by instances of the class.
+- `[in] method`: The native function that represents a method provided by the
+add-on.
+- `[in] attributes`: The attributes associated with the property. One or more of
+`napi_property_attributes`.
+- `[in] data`: User-provided data passed into the method when it is invoked.
+
+Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
+provided by instances of the class. The method must be of the form
+
+```cpp
+void MethodName(const Napi::CallbackInfo& info);
+```
+
+### InstanceMethod
+
+Creates a property descriptor that represents a method exposed on JavaScript
+instances of this class.
+
+```cpp
+template <typename T>
+static Napi::ClassPropertyDescriptor<T>
+Napi::InstanceWrap<T>::InstanceMethod(Napi::Symbol name,
+                             InstanceMethodCallback method,
+                             napi_property_attributes attributes = napi_default,
+                             void* data = nullptr);
+```
+
+- `[in] name`: JavaScript symbol that represents the name of the method provided
+by instances of the class.
+- `[in] method`: The native function that represents a method provided by the
+add-on.
+- `[in] attributes`: The attributes associated with the property. One or more of
+`napi_property_attributes`.
+- `[in] data`: User-provided data passed into the method when it is invoked.
+
+Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
+provided by instances of the class. The method must be of the form
+
+```cpp
+Napi::Value MethodName(const Napi::CallbackInfo& info);
+```
+
+### InstanceMethod
+
+Creates a property descriptor that represents a method exposed on JavaScript
+instances of this class.
+
+```cpp
+<template typename T>
+template <typename InstanceWrap<T>::InstanceVoidMethodCallback method>
+static Napi::ClassPropertyDescriptor<T>
+Napi::InstanceWrap::InstanceMethod(const char* utf8name,
+                             napi_property_attributes attributes = napi_default,
+                             void* data = nullptr);
+```
+
+- `[in] method`: The native function that represents a method provided by the
+add-on.
+- `[in] utf8name`: Null-terminated string that represents the name of the method
+provided by instances of the class.
+- `[in] attributes`: The attributes associated with the property. One or more of
+`napi_property_attributes`.
+- `[in] data`: User-provided data passed into the method when it is invoked.
+
+Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
+provided by instances of the class. The method must be of the form
+
+```cpp
+void MethodName(const Napi::CallbackInfo& info);
+```
+
+### InstanceMethod
+
+Creates a property descriptor that represents a method exposed on JavaScript
+instances of this class.
+
+```cpp
+template <typename T>
+template <typename InstanceWrap<T>::InstanceMethodCallback method>
+static Napi::ClassPropertyDescriptor<T>
+Napi::InstanceWrap<T>::InstanceMethod(const char* utf8name,
+                             napi_property_attributes attributes = napi_default,
+                             void* data = nullptr);
+```
+
+- `[in] method`: The native function that represents a method provided by the
+add-on.
+- `[in] utf8name`: Null-terminated string that represents the name of the method
+provided by instances of the class.
+- `[in] attributes`: The attributes associated with the property. One or more of
+`napi_property_attributes`.
+- `[in] data`: User-provided data passed into the method when it is invoked.
+
+Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
+provided by instances of the class. The method must be of the form
+
+```cpp
+Napi::Value MethodName(const Napi::CallbackInfo& info);
+```
+
+### InstanceMethod
+
+Creates a property descriptor that represents a method exposed on JavaScript
+instances of this class.
+
+```cpp
+template <typename T>
+template <typename InstanceWrap<T>::InstanceVoidMethodCallback method>
+static Napi::ClassPropertyDescriptor<T>
+Napi::InstanceWrap<T>::InstanceMethod(Napi::Symbol name,
+                             napi_property_attributes attributes = napi_default,
+                             void* data = nullptr);
+```
+
+- `[in] method`: The native function that represents a method provided by the
+add-on.
+- `[in] name`: The `Napi::Symbol` object whose value is used to identify the
+instance method for the class.
+- `[in] attributes`: The attributes associated with the property. One or more of
+`napi_property_attributes`.
+- `[in] data`: User-provided data passed into the method when it is invoked.
+
+Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
+provided by instances of the class. The method must be of the form
+
+```cpp
+void MethodName(const Napi::CallbackInfo& info);
+```
+
+### InstanceMethod
+
+Creates a property descriptor that represents a method exposed on JavaScript
+instances of this class.
+
+```cpp
+template <typename T>
+template <InstanceWrap<T>::InstanceMethodCallback method>
+static Napi::ClassPropertyDescriptor<T>
+Napi::InstanceWrap<T>::InstanceMethod(Napi::Symbol name,
+                             napi_property_attributes attributes = napi_default,
+                             void* data = nullptr);
+```
+
+- `[in] method`: The native function that represents a method provided by the
+add-on.
+- `[in] name`: The `Napi::Symbol` object whose value is used to identify the
+instance method for the class.
+- `[in] attributes`: The attributes associated with the property. One or more of
+`napi_property_attributes`.
+- `[in] data`: User-provided data passed into the method when it is invoked.
+
+Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
+provided by instances of the class. The method must be of the form
+
+```cpp
+Napi::Value MethodName(const Napi::CallbackInfo& info);
+```
+
+### InstanceAccessor
+
+Creates a property descriptor that represents a property exposed on JavaScript
+instances of this class.
+
+```cpp
+template <typename T>
+static Napi::ClassPropertyDescriptor<T>
+Napi::InstanceWrap<T>::InstanceAccessor(const char* utf8name,
+                             InstanceGetterCallback getter,
+                             InstanceSetterCallback setter,
+                             napi_property_attributes attributes = napi_default,
+                             void* data = nullptr);
+```
+
+- `[in] utf8name`: Null-terminated string that represents the name of the method
+provided by instances of the class.
+- `[in] getter`: The native function to call when a get access to the property
+is performed.
+- `[in] setter`: The native function to call when a set access to the property
+is performed.
+- `[in] attributes`: The attributes associated with the property. One or more of
+`napi_property_attributes`.
+- `[in] data`: User-provided data passed into the getter or the setter when it
+is invoked.
+
+Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
+accessor property provided by instances of the class.
+
+### InstanceAccessor
+
+Creates a property descriptor that represents a property exposed on JavaScript
+instances of this class.
+
+```cpp
+template <typename T>
+static Napi::ClassPropertyDescriptor<T>
+Napi::InstanceWrap<T>::InstanceAccessor(Symbol name,
+                             InstanceGetterCallback getter,
+                             InstanceSetterCallback setter,
+                             napi_property_attributes attributes = napi_default,
+                             void* data = nullptr);
+```
+
+- `[in] name`: The `Napi::Symbol` object whose value is used to identify the
+instance accessor.
+- `[in] getter`: The native function to call when a get access to the property of
+a JavaScript class is performed.
+- `[in] setter`: The native function to call when a set access to the property of
+a JavaScript class is performed.
+- `[in] attributes`: The attributes associated with the property. One or more of
+`napi_property_attributes`.
+- `[in] data`: User-provided data passed into the getter or the setter when it
+is invoked.
+
+Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
+accessor property provided instances of the class.
+
+### InstanceAccessor
+
+Creates a property descriptor that represents a property exposed on JavaScript
+instances of this class.
+
+```cpp
+template <typename T>
+template <typename InstanceWrap<T>::InstanceGetterCallback getter,
+          typename InstanceWrap<T>::InstanceSetterCallback setter=nullptr>
+static Napi::ClassPropertyDescriptor<T>
+Napi::InstanceWrap<T>::InstanceAccessor(const char* utf8name,
+                             napi_property_attributes attributes = napi_default,
+                             void* data = nullptr);
+```
+
+- `[in] getter`: The native function to call when a get access to the property of
+a JavaScript class is performed.
+- `[in] setter`: The native function to call when a set access to the property of
+a JavaScript class is performed.
+- `[in] utf8name`: Null-terminated string that represents the name of the method
+provided by instances of the class.
+- `[in] attributes`: The attributes associated with the property. One or more of
+`napi_property_attributes`.
+- `[in] data`: User-provided data passed into the getter or the setter when it
+is invoked.
+
+Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
+accessor property provided by instances of the class.
+
+### InstanceAccessor
+
+Creates a property descriptor that represents a property exposed on JavaScript
+instances of this class.
+
+```cpp
+template <typename T>
+template <typename InstanceWrap<T>::InstanceGetterCallback getter,
+          typename InstanceWrap<T>::InstanceSetterCallback setter=nullptr>
+static Napi::ClassPropertyDescriptor<T>
+Napi::InstanceWrap<T>::InstanceAccessor(Symbol name,
+                             napi_property_attributes attributes = napi_default,
+                             void* data = nullptr);
+```
+
+- `[in] getter`: The native function to call when a get access to the property of
+a JavaScript class is performed.
+- `[in] setter`: The native function to call when a set access to the property of
+a JavaScript class is performed.
+- `[in] name`: The `Napi::Symbol` object whose value is used to identify the
+instance accessor.
+- `[in] attributes`: The attributes associated with the property. One or more of
+`napi_property_attributes`.
+- `[in] data`: User-provided data passed into the getter or the setter when it
+is invoked.
+
+Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
+accessor property provided by instances of the class.
+
+### InstanceValue
+
+Creates property descriptor that represents a value exposed on JavaScript
+instances of this class.
+
+```cpp
+template <typename T>
+static Napi::ClassPropertyDescriptor<T>
+Napi::InstanceWrap<T>::InstanceValue(const char* utf8name,
+                            Napi::Value value,
+                            napi_property_attributes attributes = napi_default);
+```
+
+- `[in] utf8name`: Null-terminated string that represents the name of the
+property.
+- `[in] value`: The value that's retrieved by a get access of the property.
+- `[in] attributes`: The attributes associated with the property. One or more of
+`napi_property_attributes`.
+
+Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
+value property of an add-on.
+
+### InstanceValue
+
+Creates property descriptor that represents a value exposed on JavaScript
+instances of this class.
+
+```cpp
+template <typename T>
+static Napi::ClassPropertyDescriptor<T>
+Napi::InstanceWrap<T>::InstanceValue(Symbol name,
+                            Napi::Value value,
+                            napi_property_attributes attributes = napi_default);
+```
+
+- `[in] name`: The `Napi::Symbol` object whose value is used to identify the
+name of the property.
+- `[in] value`: The value that's retrieved by a get access of the property.
+- `[in] attributes`: The attributes associated with the property. One or more of
+`napi_property_attributes`.
+
+Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
+value property of an add-on.
+
+[`Napi::Addon<T>`]: ./addon.md
+[`Napi::ObjectWrap<T>`]: ./object_wrap.md