Skip to content

Commit

Permalink
string.md: Document existing New(env, value, length) APIs
Browse files Browse the repository at this point in the history
PR-URL: #486
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: NickNaso <[email protected]>
  • Loading branch information
tux3 authored and mhdawson committed Jun 5, 2019
1 parent aaea55e commit f633fbd
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/string.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ Napi::String::New(napi_env env, const std::string& value);
Napi::String::New(napi_env env, const std::u16::string& value);
Napi::String::New(napi_env env, const char* value);
Napi::String::New(napi_env env, const char16_t* value);
Napi::String::New(napi_env env, const char* value, size_t length);
Napi::String::New(napi_env env, const char16_t* value, size_t length);
```
- `[in] env`: The `napi_env` environment in which to construct the `Napi::Value` object.
Expand All @@ -64,6 +66,7 @@ Napi::String::New(napi_env env, const char16_t* value);
- `std::u16string&` - represents a UTF16-LE string.
- `const char*` - represents a UTF8 string.
- `const char16_t*` - represents a UTF16-LE string.
- `[in] length`: The length of the string (not necessarily null-terminated) in code units.
Returns a new `Napi::String` that represents the passed in C++ string.
Expand Down

0 comments on commit f633fbd

Please sign in to comment.