diff --git a/doc/api/perf_hooks.md b/doc/api/perf_hooks.md index e61710d1ec96fd..a35cef0f02da22 100644 --- a/doc/api/perf_hooks.md +++ b/doc/api/perf_hooks.md @@ -815,10 +815,11 @@ added: v15.9.0 --> * `options` {Object} - * `min` {number|bigint} The minimum recordable value. Must be an integer + * `lowest` {number|bigint} The lowest discernible value. Must be an integer value greater than 0. **Default:** `1`. - * `max` {number|bigint} The maximum recordable value. Must be an integer - value greater than `min`. **Default:** `Number.MAX_SAFE_INTEGER`. + * `highest` {number|bigint} The highest recordable value. Must be an integer + value that is equal to or greater than two times `min`. + **Default:** `Number.MAX_SAFE_INTEGER`. * `figures` {number} The number of accuracy digits. Must be a number between `1` and `5`. **Default:** `3`. * Returns {RecordableHistogram} @@ -868,6 +869,26 @@ console.log(h.percentile(99)); added: v11.10.0 --> +### `histogram.count` + + + +* {number} + +The number of samples recorded by the histogram. + +### `histogram.countBigInt` + + + +* {bigint} + +The number of samples recorded by the histogram. + ### `histogram.exceeds` + +* {bigint} + +The number of times the event loop delay exceeded the maximum 1 hour event +loop delay threshold. + ### `histogram.max` + +* {bigint} + +The maximum recorded event loop delay. + ### `histogram.mean` + +* {bigint} + +The minimum recorded event loop delay. + ### `histogram.percentile(percentile)` + +* `percentile` {number} A percentile value in the range (0, 100). +* Returns: {bigint} + +Returns the value at the given percentile. + ### `histogram.percentiles` + +* {Map} + +Returns a `Map` object detailing the accumulated percentile distribution. + ### `histogram.reset()` +### `histogram.add(other)` + + + +* `other` {RecordableHistogram} + +Adds the values from `other` to this histogram. + ### `histogram.record(val)`