TripSit/TripSit_Suite
Archived
4
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
This repository has been archived on 2020-11-02. You can view files and clone it, but cannot push or open issues or pull requests.
TripSit_Suite/node_modules/node-addon-api/doc/symbol.md
cranberry ed23347e56 Initial comission of TheLounge base files
2020-11-01 22:46:04 +00:00

1.4 KiB
Raw Permalink Blame History

Symbol

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, 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:
    • std::string& - ANSI string description.
    • const char* - represents a UTF8 string description.
    • String - Node addon API String description.
    • napi_value - N-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.

Utf8Value

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.