diff options
| author | Andrey Pechkurov <apechkurov@gmail.com> | 2020-10-03 16:57:35 +0300 |
|---|---|---|
| committer | Danielle Adams <adamzdanielle@gmail.com> | 2020-10-06 22:10:25 +0300 |
| commit | 6585b161ba662bd6199e0428341cd3f6af86957a (patch) | |
| tree | 7287798446dabbb02a47e7d84aeb46017c2779da /doc | |
| parent | 0ac5fa703e2ea1bc902ab051b200e86157c0666d (diff) | |
doc: improve eventLoopUtilization documentation
PR-URL: https://github.com/nodejs/node/pull/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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/perf_hooks.md | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/api/perf_hooks.md b/doc/api/perf_hooks.md index d67bc8436f9..6b14a23c474 100644 --- a/doc/api/perf_hooks.md +++ b/doc/api/perf_hooks.md @@ -58,9 +58,10 @@ Performance Timeline. If `name` is provided, removes only the named mark. added: v14.10.0 --> -* `utilization1` {Object} The result of a previous call to `eventLoopUtilization()` -* `utilization2` {Object} The result of a previous call to `eventLoopUtilization()` - prior to `util1` +* `utilization1` {Object} The result of a previous call to + `eventLoopUtilization()`. +* `utilization2` {Object} The result of a previous call to + `eventLoopUtilization()` prior to `utilization1`. * Returns {Object} * `idle` {number} * `active` {number} @@ -70,9 +71,9 @@ The `eventLoopUtilization()` method returns an object that contains the cumulative duration of time the event loop has been both idle and active as a high resolution milliseconds timer. The `utilization` value is the calculated Event Loop Utilization (ELU). If bootstrapping has not yet finished, the -properties have the value of 0. +properties have the value of `0`. -`utilization1` and `utilization2` are optional parameters. +Both `utilization1` and `utilization2` are optional parameters. If `utilization1` is passed, then the delta between the current call's `active` and `idle` times, as well as the corresponding `utilization` value are @@ -102,8 +103,8 @@ setImmediate(() => { ``` Although the CPU is mostly idle while running this script, the value of -`utilization` is 1. This is because the call to [`child_process.spawnSync()`][] -blocks the event loop from proceeding. +`utilization` is `1`. This is because the call to +[`child_process.spawnSync()`][] blocks the event loop from proceeding. Passing in a user-defined object instead of the result of a previous call to `eventLoopUtilization()` will lead to undefined behavior. The return values |