Commit 6585b16
doc: improve eventLoopUtilization documentation
PR-URL: #35479
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>1 parent 0ac5fa7 commit 6585b16
1 file changed
Lines changed: 8 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -58,9 +58,10 @@ Performance Timeline. If `name` is provided, removes only the named mark. | |||
| 58 | 58 | added: v14.10.0 | |
| 59 | 59 | --> | |
| 60 | 60 | ||
| 61 | - * `utilization1` {Object} The result of a previous call to `eventLoopUtilization()` | ||
| 62 | - * `utilization2` {Object} The result of a previous call to `eventLoopUtilization()` | ||
| 63 | - prior to `util1` | ||
| 61 | + * `utilization1` {Object} The result of a previous call to | ||
| 62 | + `eventLoopUtilization()`. | ||
| 63 | + * `utilization2` {Object} The result of a previous call to | ||
| 64 | + `eventLoopUtilization()` prior to `utilization1`. | ||
| 64 | 65 | * Returns {Object} | |
| 65 | 66 | * `idle` {number} | |
| 66 | 67 | * `active` {number} | |
@@ -70,9 +71,9 @@ The `eventLoopUtilization()` method returns an object that contains the | |||
| 70 | 71 | cumulative duration of time the event loop has been both idle and active as a | |
| 71 | 72 | high resolution milliseconds timer. The `utilization` value is the calculated | |
| 72 | 73 | Event Loop Utilization (ELU). If bootstrapping has not yet finished, the | |
| 73 | - properties have the value of 0. | ||
| 74 | + properties have the value of `0`. | ||
| 74 | 75 | ||
| 75 | - `utilization1` and `utilization2` are optional parameters. | ||
| 76 | + Both `utilization1` and `utilization2` are optional parameters. | ||
| 76 | 77 | ||
| 77 | 78 | If `utilization1` is passed, then the delta between the current call's `active` | |
| 78 | 79 | and `idle` times, as well as the corresponding `utilization` value are | |
@@ -102,8 +103,8 @@ setImmediate(() => { | |||
| 102 | 103 | ``` | |
| 103 | 104 | ||
| 104 | 105 | Although the CPU is mostly idle while running this script, the value of | |
| 105 | - `utilization` is 1. This is because the call to [`child_process.spawnSync()`][] | ||
| 106 | - blocks the event loop from proceeding. | ||
| 106 | + `utilization` is `1`. This is because the call to | ||
| 107 | + [`child_process.spawnSync()`][] blocks the event loop from proceeding. | ||
| 107 | 108 | ||
| 108 | 109 | Passing in a user-defined object instead of the result of a previous call to | |
| 109 | 110 | `eventLoopUtilization()` will lead to undefined behavior. The return values | |
0 commit comments