@@ -1526,11 +1526,11 @@ for a reference is 0, all subsequent calls to
1526
1526
get the object associated with the reference [`napi_get_reference_value`][]
1527
1527
will return `NULL` for the returned `napi_value`. An attempt to call
1528
1528
[`napi_reference_ref`][] for a reference whose object has been collected
1529
- will result in an error.
1529
+ results in an error.
1530
1530
1531
1531
References must be deleted once they are no longer required by the addon. When
1532
- a reference is deleted it will no longer prevent the corresponding object from
1533
- being collected. Failure to delete a persistent reference will result in
1532
+ a reference is deleted, it will no longer prevent the corresponding object from
1533
+ being collected. Failure to delete a persistent reference results in
1534
1534
a 'memory leak' with both the native memory for the persistent reference and
1535
1535
the corresponding object on the heap being retained forever.
1536
1536
@@ -3089,7 +3089,7 @@ napi_status napi_get_value_string_latin1(napi_env env,
3089
3089
passed in, the length of the string in bytes and excluding the null terminator
3090
3090
is returned in `result`.
3091
3091
* `[in] bufsize`: Size of the destination buffer. When this value is
3092
- insufficient, the returned string will be truncated and null-terminated.
3092
+ insufficient, the returned string is truncated and null-terminated.
3093
3093
* `[out] result`: Number of bytes copied into the buffer, excluding the null
3094
3094
terminator.
3095
3095
@@ -3119,7 +3119,7 @@ napi_status napi_get_value_string_utf8(napi_env env,
3119
3119
in, the length of the string in bytes and excluding the null terminator is
3120
3120
returned in `result`.
3121
3121
* `[in] bufsize`: Size of the destination buffer. When this value is
3122
- insufficient, the returned string will be truncated and null-terminated.
3122
+ insufficient, the returned string is truncated and null-terminated.
3123
3123
* `[out] result`: Number of bytes copied into the buffer, excluding the null
3124
3124
terminator.
3125
3125
@@ -3148,7 +3148,7 @@ napi_status napi_get_value_string_utf16(napi_env env,
3148
3148
passed in, the length of the string in 2-byte code units and excluding the
3149
3149
null terminator is returned.
3150
3150
* `[in] bufsize`: Size of the destination buffer. When this value is
3151
- insufficient, the returned string will be truncated and null-terminated.
3151
+ insufficient, the returned string is truncated and null-terminated.
3152
3152
* `[out] result`: Number of 2-byte code units copied into the buffer, excluding
3153
3153
the null terminator.
3154
3154
@@ -5137,8 +5137,8 @@ napi_status napi_async_init(napi_env env,
5137
5137
* `[in] async_resource`: Object associated with the async work
5138
5138
that will be passed to possible `async_hooks` [`init` hooks][].
5139
5139
In order to retain ABI compatibility with previous versions,
5140
- passing `NULL` for `async_resource` will not result in an error, however ,
5141
- this will result incorrect operation of async hooks for the
5140
+ passing `NULL` for `async_resource` does not result in an error. However ,
5141
+ this results in incorrect operation of async hooks for the
5142
5142
napi_async_context created. Potential issues include
5143
5143
loss of async context when using the AsyncLocalStorage API.
5144
5144
* `[in] async_resource_name`: Identifier for the kind of resource
@@ -5190,7 +5190,7 @@ NAPI_EXTERN napi_status napi_make_callback(napi_env env,
5190
5190
invoking the callback. This should normally be a value previously
5191
5191
obtained from [`napi_async_init`][].
5192
5192
In order to retain ABI compatibility with previous versions, passing `NULL`
5193
- for `async_context` will not result in an error. However, this will result
5193
+ for `async_context` does not result in an error. However, this results
5194
5194
in incorrect operation of async hooks. Potential issues include loss of
5195
5195
async context when using the `AsyncLocalStorage` API.
5196
5196
* `[in] recv`: The `this` object passed to the called function.
0 commit comments