18c339a94Sopenharmony_ci# Symbol 28c339a94Sopenharmony_ci 38c339a94Sopenharmony_ciClass `Napi::Symbol` inherits from class [`Napi::Name`][]. 48c339a94Sopenharmony_ci 58c339a94Sopenharmony_ci## Methods 68c339a94Sopenharmony_ci 78c339a94Sopenharmony_ci### Constructor 88c339a94Sopenharmony_ci 98c339a94Sopenharmony_ciInstantiates a new `Napi::Symbol` value. 108c339a94Sopenharmony_ci 118c339a94Sopenharmony_ci```cpp 128c339a94Sopenharmony_ciNapi::Symbol::Symbol(); 138c339a94Sopenharmony_ci``` 148c339a94Sopenharmony_ci 158c339a94Sopenharmony_ciReturns a new empty `Napi::Symbol`. 168c339a94Sopenharmony_ci 178c339a94Sopenharmony_ci### New 188c339a94Sopenharmony_ci```cpp 198c339a94Sopenharmony_ciNapi::Symbol::New(napi_env env, const std::string& description); 208c339a94Sopenharmony_ciNapi::Symbol::New(napi_env env, const char* description); 218c339a94Sopenharmony_ciNapi::Symbol::New(napi_env env, Napi::String description); 228c339a94Sopenharmony_ciNapi::Symbol::New(napi_env env, napi_value description); 238c339a94Sopenharmony_ci``` 248c339a94Sopenharmony_ci 258c339a94Sopenharmony_ci- `[in] env`: The `napi_env` environment in which to construct the `Napi::Symbol` object. 268c339a94Sopenharmony_ci- `[in] value`: The C++ primitive which represents the description hint for the `Napi::Symbol`. 278c339a94Sopenharmony_ci `description` may be any of: 288c339a94Sopenharmony_ci - `std::string&` - UTF8 string description. 298c339a94Sopenharmony_ci - `const char*` - represents a UTF8 string description. 308c339a94Sopenharmony_ci - `String` - Node addon API String description. 318c339a94Sopenharmony_ci - `napi_value` - Node-API `napi_value` description. 328c339a94Sopenharmony_ci 338c339a94Sopenharmony_ciIf an error occurs, a `Napi::Error` will get thrown. If C++ exceptions are not 348c339a94Sopenharmony_cibeing used, callers should check the result of `Napi::Env::IsExceptionPending` before 358c339a94Sopenharmony_ciattempting to use the returned value. 368c339a94Sopenharmony_ci 378c339a94Sopenharmony_ci### WellKnown 388c339a94Sopenharmony_ci```cpp 398c339a94Sopenharmony_cistatic Napi::Symbol Napi::Symbol::WellKnown(napi_env env, const std::string& name); 408c339a94Sopenharmony_ci``` 418c339a94Sopenharmony_ci 428c339a94Sopenharmony_ci- `[in] env`: The `napi_env` environment in which to construct the `Napi::Symbol` object. 438c339a94Sopenharmony_ci- `[in] name`: The C++ string representing the `Napi::Symbol` to retrieve. 448c339a94Sopenharmony_ci 458c339a94Sopenharmony_ciReturns a `Napi::Symbol` representing a well-known `Symbol` from the 468c339a94Sopenharmony_ci`Symbol` registry. 478c339a94Sopenharmony_ci 488c339a94Sopenharmony_ci### For 498c339a94Sopenharmony_ci```cpp 508c339a94Sopenharmony_cistatic Napi::Symbol Napi::Symbol::For(napi_env env, const std::string& description); 518c339a94Sopenharmony_cistatic Napi::Symbol Napi::Symbol::For(napi_env env, const char* description); 528c339a94Sopenharmony_cistatic Napi::Symbol Napi::Symbol::For(napi_env env, String description); 538c339a94Sopenharmony_cistatic Napi::Symbol Napi::Symbol::For(napi_env env, napi_value description); 548c339a94Sopenharmony_ci``` 558c339a94Sopenharmony_ci 568c339a94Sopenharmony_ci- `[in] env`: The `napi_env` environment in which to construct the `Napi::Symbol` object. 578c339a94Sopenharmony_ci- `[in] description`: The C++ string representing the `Napi::Symbol` in the global registry to retrieve. 588c339a94Sopenharmony_ci 598c339a94Sopenharmony_ciSearches 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. 608c339a94Sopenharmony_ci 618c339a94Sopenharmony_ci[`Napi::Name`]: ./name.md