Skip to content

string.md

Latest commit

 

History

History
86 lines (62 loc) · 2.05 KB

string.md

File metadata and controls

86 lines (62 loc) · 2.05 KB

String

Constructor

String();

Returns a new empty String instance.

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

String(napi_env env, napi_value value); ///< Wraps a N-API value primitive.
  • [in] env - The environment in which to create the string.
  • [in] value - The primitive to wrap.

Returns a Napi::String wrapping a napi_value.

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

Operators

operator std::string

operator std::string() const;

Returns a UTF-8 encoded C++ string.

operator std::u16string

operator std::u16string() const;

Returns a UTF-16 encoded C++ string.

Methods

New

String::New();

Returns a new empty String

New

String::New(napi_env env, const std::string& value);
String::New(napi_env env, const std::u16string& value);
String::New(napi_env env, const char* value);
String::New(napi_env env, const char16_t* value);
  • [in] env: The napi_env environment in which to construct the Value object.
  • [in] value: The C++ primitive from which to instantiate the Value. value may be any of:
    • std::string& - represents an ANSI string.
    • std::u16string& - represents a UTF16-LE string.
    • const char* - represents a UTF8 string.
    • const char16_t* - represents a UTF16-LE string.

Returns a new Napi::String that represents the passed in C++ string.

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

Utf8Value

std::string Utf8Value() const;

Returns a UTF-8 encoded C++ string.

Utf16Value

std::u16string Utf16Value() const;

Returns a UTF-16 encoded C++ string.