Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 2.09 KB

external.md

File metadata and controls

61 lines (42 loc) · 2.09 KB
Raw

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

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

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

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

T* Data() const;

Returns a pointer to the arbitrary C++ data held by the External object.