Skip to content

Commit ca74d64

Browse files
authored
doc: clarify behaviour of node-api adjust function
Refs: #57351 - based on recent request to update one of the tests Signed-off-by: Michael Dawson <[email protected]> PR-URL: #57463 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]> Reviewed-By: Vladimir Morozov <[email protected]>
1 parent af75d04 commit ca74d64

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

Diff for: doc/api/n-api.md

+14-5
Original file line numberDiff line numberDiff line change
@@ -6126,16 +6126,25 @@ NAPI_EXTERN napi_status napi_adjust_external_memory(node_api_basic_env env,
61266126
* `[in] env`: The environment that the API is invoked under.
61276127
* `[in] change_in_bytes`: The change in externally allocated memory that is kept
61286128
alive by JavaScript objects.
6129-
* `[out] result`: The adjusted value
6129+
* `[out] result`: The adjusted value. This value should reflect the
6130+
total amount of external memory with the given `change_in_bytes` included.
6131+
The absolute value of the returned value should not be depended on.
6132+
For example, implementations may use a single counter for all addons, or a
6133+
counter for each addon.
61306134

61316135
Returns `napi_ok` if the API succeeded.
61326136

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
6137+
This function gives the runtime an indication of the amount of externally
6138+
allocated memory that is kept alive by JavaScript objects
6139+
(i.e. a JavaScript object that points to its own memory allocated by a
6140+
native addon). Registering externally allocated memory may, but is not
6141+
guaranteed to, trigger global garbage collections more
61376142
often than it would otherwise.
61386143

6144+
This function is expected to be called in a manner such that an
6145+
addon does not decrease the external memory more than it has
6146+
increased the external memory.
6147+
61396148
## Promises
61406149

61416150
Node-API provides facilities for creating `Promise` objects as described in

0 commit comments

Comments
 (0)