Commit 081a6ff
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: #41639
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Debadree Chatterjee <debadree333@gmail.com>1 parent dc318f2 commit 081a6ff
1 file changed
Lines changed: 2 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1140,8 +1140,9 @@ current V8 isolate, or the main context. | |||
| 1140 | 1140 | exits before the next GC). With eager execution, the GC will be started | |
| 1141 | 1141 | right away to measure the memory. | |
| 1142 | 1142 | **Default:** `'default'` | |
| 1143 | - * Returns: {Promise} If the memory is successfully measured the promise will | ||
| 1143 | + * Returns: {Promise} If the memory is successfully measured, the promise will | ||
| 1144 | 1144 | resolve with an object containing information about the memory usage. | |
| 1145 | + Otherwise it will be rejected with an `ERR_CONTEXT_NOT_INITIALIZED` error. | ||
| 1145 | 1146 | ||
| 1146 | 1147 | The format of the object that the returned Promise may resolve with is | |
| 1147 | 1148 | specific to the V8 engine and may change from one version of V8 to the next. | |
0 commit comments