diff options
| author | Yash Ladha <18033231+yashLadha@users.noreply.github.com> | 2023-05-13 23:58:25 +0530 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-13 18:28:25 +0000 |
| commit | 8115c2f46cba96c0b4e1dc6294f75d5753a6fd84 (patch) | |
| tree | 24278a43f9112bee179da8e0b55ffd6d2c9a69a9 | |
| parent | 5ec0f39a7a565b5a82fe90ba9f095731a7b8b005 (diff) | |
| download | node-new-8115c2f46cba96c0b4e1dc6294f75d5753a6fd84.tar.gz | |
doc: update measure memory rejection information
If in case context is unable to allocate a promise then
`ERR_CONTEXT_NOT_INITIALIZED` error will be thrown (as promise
rejection) in the vm measureMemory call.
PR-URL: https://github.com/nodejs/node/pull/41639
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Debadree Chatterjee <debadree333@gmail.com>
| -rw-r--r-- | doc/api/vm.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/api/vm.md b/doc/api/vm.md index 1c043d119d..7631b39353 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -1143,8 +1143,9 @@ current V8 isolate, or the main context. exits before the next GC). With eager execution, the GC will be started right away to measure the memory. **Default:** `'default'` -* Returns: {Promise} If the memory is successfully measured the promise will +* Returns: {Promise} If the memory is successfully measured, the promise will resolve with an object containing information about the memory usage. + Otherwise it will be rejected with an `ERR_CONTEXT_NOT_INITIALIZED` error. The format of the object that the returned Promise may resolve with is specific to the V8 engine and may change from one version of V8 to the next. |