File tree 1 file changed +9
-5
lines changed
1 file changed +9
-5
lines changed Original file line number Diff line number Diff line change @@ -6126,14 +6126,18 @@ NAPI_EXTERN napi_status napi_adjust_external_memory(node_api_basic_env env,
6126
6126
* `[in] env`: The environment that the API is invoked under.
6127
6127
* `[in] change_in_bytes`: The change in externally allocated memory that is kept
6128
6128
alive by JavaScript objects.
6129
- * `[out] result`: The adjusted value
6129
+ * `[out] result`: The adjusted value. Their is no guarrantee that a request to
6130
+ adjust by X bytes will result in an adjusted value being X bytes larger than
6131
+ before the request. The runtime is free to adjust in the manner it deems
6132
+ most appropriate.
6130
6133
6131
6134
Returns `napi_ok` if the API succeeded.
6132
6135
6133
- This function gives V8 an indication of the amount of externally allocated
6134
- memory that is kept alive by JavaScript objects (i.e. a JavaScript object
6135
- that points to its own memory allocated by a native addon). Registering
6136
- externally allocated memory will trigger global garbage collections more
6136
+ This function gives the runtime an indication of the amount of externally
6137
+ allocated memory that is kept alive by JavaScript objects
6138
+ (i.e. a JavaScript object that points to its own memory allocated by a
6139
+ native addon). Registering externally allocated memory may, but is not
6140
+ guarranteed to, trigger global garbage collections more
6137
6141
often than it would otherwise.
6138
6142
6139
6143
## Promises
You can’t perform that action at this time.
0 commit comments