Symbol

Class Napi::Symbol inherits from class Napi::Name.

Methods

Constructor

Instantiates a new Napi::Symbol value.

Napi::Symbol::Symbol();

Returns a new empty Napi::Symbol.

New

Napi::Symbol::New(napi_env env, const std::string& description);
Napi::Symbol::New(napi_env env, const char* description);
Napi::Symbol::New(napi_env env, std::string_view description);
Napi::Symbol::New(napi_env env, Napi::String description);
Napi::Symbol::New(napi_env env, napi_value description);

• [in] env: The napi_env environment in which to construct the Napi::Symbol object.
• [in] value: The C++ primitive which represents the description hint for the Napi::Symbol. description may be any of:
  • const std::string& - UTF8 string description.
  • const char* - represents a UTF8 string description.
  • std::string_view - represents a UTF8 string view.
  • String - Node addon API String description.
  • napi_value - Node-API napi_value description.

If an error occurs, a Napi::Error will get thrown. If C++ exceptions are not being used, callers should check the result of Napi::Env::IsExceptionPending before attempting to use the returned value.

WellKnown

static Napi::Symbol Napi::Symbol::WellKnown(napi_env env, const std::string& name);

• [in] env: The napi_env environment in which to construct the Napi::Symbol object.
• [in] name: The C++ string representing the Napi::Symbol to retrieve.

Returns a Napi::Symbol representing a well-known Symbol from the Symbol registry.

For

static Napi::Symbol Napi::Symbol::For(napi_env env, const std::string& description);
static Napi::Symbol Napi::Symbol::For(napi_env env, std::string_view description);
template <typename T>
static Napi::Symbol Napi::Symbol::For(napi_env env, T&& description);
static Napi::Symbol Napi::Symbol::For(napi_env env, const char* description);
static Napi::Symbol Napi::Symbol::For(napi_env env, Napi::String description);
static Napi::Symbol Napi::Symbol::For(napi_env env, napi_value description);

• [in] env: The napi_env environment in which to construct the Napi::Symbol object.
• [in] description: The C++ string representing the Napi::Symbol in the global registry to retrieve. description may be any of:
  • const std::string& - represents a UTF-8 string.
  • std::string_view - represents a UTF-8 string view.
  • const char* - represents a UTF-8 string description.
  • Napi::String - Node-API string description.
  • napi_value - Node-API napi_value description.

String-like arguments implicitly convertible to both const std::string& and std::string_view that do not have a unique best match among the non-template overloads are resolved through std::string_view.

Searches in the global registry for existing symbol with the given name. If the symbol already exist it will be returned, otherwise a new symbol will be created in the registry. It’s equivalent to Symbol.for() called from JavaScript.