Skip to content

Commit 2583bbf

Browse files
committed
doc: align perf_hooks histogram class name with implementation
align perf_hooks docs after renaming internal ELDHistogram to IterationHistogram
1 parent 6e6b503 commit 2583bbf

1 file changed

Lines changed: 9 additions & 13 deletions

File tree

doc/api/perf_hooks.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1718,7 +1718,7 @@ changes:
17181718
* `resolution` {number} The sampling rate in milliseconds for interval-based
17191719
sampling. Must be greater than zero. This option is ignored when
17201720
`samplePerIteration` is `true`. **Default:** `10`.
1721-
* Returns: {IntervalHistogram|ELDHistogram}
1721+
* Returns: {ELDHistogram}
17221722

17231723
_This property is an extension by Node.js. It is not available in Web browsers._
17241724

@@ -2008,9 +2008,10 @@ added: v11.10.0
20082008

20092009
The standard deviation of the recorded event loop delays.
20102010

2011-
## Class: `IntervalHistogram extends Histogram`
2011+
## Class: `ELDHistogram extends Histogram`
20122012

2013-
A `Histogram` that records event loop delay using interval-based sampling.
2013+
A `Histogram` that records event loop delay, returned by
2014+
[`perf_hooks.monitorEventLoopDelay()`][].
20142015

20152016
### `histogram.disable()`
20162017

@@ -2051,17 +2052,11 @@ const { monitorEventLoopDelay } = require('node:perf_hooks');
20512052
}
20522053
```
20532054

2054-
### Cloning event loop delay histograms
2055-
2056-
{IntervalHistogram} and {ELDHistogram} instances can be cloned via
2057-
{MessagePort}. On the receiving end, the histogram is cloned as a plain
2058-
{Histogram} object that does not implement the `enable()` and `disable()`
2059-
methods.
2060-
2061-
## Class: `ELDHistogram extends Histogram`
2055+
### Cloning an `ELDHistogram`
20622056

2063-
A `Histogram` that records event loop delay once per event loop iteration. It
2064-
provides the same API as {IntervalHistogram}.
2057+
{ELDHistogram} instances can be cloned via {MessagePort}. On the receiving end,
2058+
the histogram is cloned as a plain {Histogram} object that does not implement
2059+
the `enable()` and `disable()` methods.
20652060

20662061
## Class: `RecordableHistogram extends Histogram`
20672062

@@ -2369,6 +2364,7 @@ dns.promises.resolve('localhost');
23692364
[`'exit'`]: process.md#event-exit
23702365
[`child_process.spawnSync()`]: child_process.md#child_processspawnsynccommand-args-options
23712366
[`perf_hooks.eventLoopUtilization()`]: #perf_hookseventlooputilizationutilization1-utilization2
2367+
[`perf_hooks.monitorEventLoopDelay()`]: #perf_hooksmonitoreventloopdelayoptions
23722368
[`perf_hooks.timerify()`]: #perf_hookstimerifyfn-options
23732369
[`process.hrtime()`]: process.md#processhrtimetime
23742370
[`timeOrigin`]: https://w3c.github.io/hr-time/#dom-performance-timeorigin

0 commit comments

Comments
 (0)