doc: Initial documetation for Basic Types.

PR-URL: #165
Reviewed-By: Michael Dawson <[email protected]>

Author: jschlight

doc/callbackinfo.md

@@ -0,0 +1,100 @@
+**WORK IN PROGRESS, NOT YET COMPLETE**
+
+# CallbackInfo
+
+The object representing the components of the JavaScript request being made.
+
+The CallbackInfo object is usually created and passed by the Node.js runtime or node-addon-api infrastructure.
+
+The 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 CallbackInfo object.
+
+## Methods
+
+### Constructor
+
+```cpp
+CallbackInfo(napi_env env, napi_callback_info info);
+```
+
+- `[in] env`: The `napi_env` environment in which to construct the `CallbackInfo` object.
+- `[in] info`: The `napi_callback_info` data structure from which to construct the `CallbackInfo` object.
+
+### Env
+
+```cpp
+Napi::Env Env() const;
+```
+
+Returns the `Env` object in which the request is being made.
+
+### NewTarget
+
+```cpp
+Value NewTarget() const;
+```
+
+Returns the `new.target` value of the constructor call. If the function that was invoked (and for which the CallbackInfo was passed) is not a constructor call, a call to `IsEmpty()` on the returned value returns true.
+
+### IsConstructCall
+
+```cpp
+bool IsConstructCall() const;
+```
+
+Returns a `bool` indicating if the function that was invoked (and for which the CallbackInfo was passed) is a constructor call.
+
+
+### Length
+
+```cpp
+size_t Length() const;
+```
+
+Returns the number of arguments passed in the Callabckinfo object.
+
+### operator []
+
+```cpp
+const Value operator [](size_t index) const;
+```
+
+- `[in] index`: The zero-based index of the requested argument.
+
+Returns a `Value` object containing the requested argument.
+
+### This
+
+```cpp
+Value This() const;
+```
+
+Returns the JavaScript `this` value for the call
+
+### Data
+
+```cpp
+void* Data() const;
+```
+
+Returns the data pointer for the callback.
+
+### SetData
+
+```cpp
+void SetData(void* data);
+```
+
+- `[in] data`: The new data pointer to associate with this CallbackInfo object.
+
+Returns `void`.
+
+### Not documented here
+
+```cpp
+~CallbackInfo();
+// Disallow copying to prevent multiple free of _dynamicArgs
+CallbackInfo(CallbackInfo const &) = delete;
+void operator=(CallbackInfo const &) = delete;
+```

doc/env.md

@@ -0,0 +1,65 @@
+**WORK IN PROGRESS, NOT YET COMPLETE**
+
+# Env
+
+The opaque data structure containing the environment in which the request is being run.
+
+The Env object is usually created and passed by the Node.js runtime or node-addon-api infrastructure.
+
+## Methods
+
+### Constructor
+
+```cpp
+Env(napi_env env);
+```
+
+- `[in] env`: The `napi_env` environment from which to construct the `Env` object.
+
+### napi_env
+
+```cpp
+operator napi_env() const;
+```
+
+Returns the `napi_env` opaque data structure representing the environment.
+
+### Global
+
+```cpp
+Object Global() const;
+```
+
+Returns the `Object` representing the environment's JavaScript Global Object.
+
+### Undefined
+
+```cpp
+Value Undefined() const;
+```
+
+Returns the `Value` representing the environment's JavaScript Undefined Object.
+
+### Null
+
+```cpp
+Value Null() const;
+```
+
+Returns the `Value` representing the environment's JavaScript Null Object.
+
+### IsExceptionPending
+
+```cpp
+bool IsExceptionPending() const;
+```
+
+Returns a `bool` indicating if an exception is pending in the environment.
+
+### GetAndClearPendingException
+
+```cpp
+Error GetAndClearPendingException();
+```
+
+Returns an `Error` object representing the environment's pending exception, if any.

doc/external.md

@@ -0,0 +1,61 @@
+**WORK IN PROGRESS, NOT YET COMPLETE**
+
+# External (template)
+
+The External template class implements the ability to create a Value object with arbitrary C++ data. It is the user's responsibility to manage the memory for the arbitrary C++ data.
+
+External objects can be created with an optional Finalizer function and optional Hint value. The Finalizer function, if specified, is called when your External object is released by Node's garbage collector. It gives your code the opportunity to free any dynamically created data. If you specify a Hint value, it is passed to your Finalizer function.
+
+## Methods
+
+### New
+
+```cpp
+template <typename T>
+static External New(napi_env env, T* data);
+```
+
+- `[in] env`: The `napi_env` environment in which to construct the External object.
+- `[in] data`: The arbitrary C++ data to be held by the External object.
+
+Returns the created `External<T>` object.
+
+### New
+
+```cpp
+template <typename T>
+static External New(napi_env env,
+                    T* data,
+                    Finalizer finalizeCallback);
+```
+
+- `[in] env`: The `napi_env` environment in which to construct the External object.
+- `[in] data`: The arbitrary C++ data to be held by the External object.
+- `[in] finalizeCallback`: A function called when the External object is released by the garbage collector accepting a T* and returning void.
+
+Returns the created `External<T>` object.
+
+### New
+
+```cpp
+template <typename T>
+static External New(napi_env env,
+                    T* data,
+                    Finalizer finalizeCallback,
+                    Hint* finalizeHint);
+```
+
+- `[in] env`: The `napi_env` environment in which to construct the External object.
+- `[in] data`: The arbitrary C++ data to be held by the External object.
+- `[in] finalizeCallback`: A function called when the External object is released by the garbage collector accepting T* and Hint* parameters and returning void.
+- `[in] finalizeHint`: A hint value passed to the `finalizeCallback` function.
+
+Returns the created `External<T>` object.
+
+### Data
+
+```cpp
+T* Data() const;
+```
+
+Returns a pointer to the arbitrary C++ data held by the External object.