From f633fbd95d233adc8f030954651a76ec4c8d07f9 Mon Sep 17 00:00:00 2001 From: Tux3 Date: Wed, 5 Jun 2019 21:18:05 +0200 Subject: [PATCH] string.md: Document existing New(env, value, length) APIs PR-URL: https://github.com/nodejs/node-addon-api/pull/486 Reviewed-By: Michael Dawson Reviewed-By: NickNaso --- doc/string.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/string.md b/doc/string.md index 21ce8f8cb..bf78ac73c 100644 --- a/doc/string.md +++ b/doc/string.md @@ -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. @@ -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.