Commit de52eb8
perf_hooks: remove docs for unimplemented API
The node frame (aka loop) timing API did not land, it depends on
libuv/libuv#1489 which is still a WIP.
See: #14680 (comment)
PR-URL: #15641
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>1 parent 1cc4245 commit de52eb8
1 file changed
Lines changed: 0 additions & 41 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -135,16 +135,6 @@ the Performance Timeline or any of the timestamp properties provided by the | |||
| 135 | 135 | `PerformanceNodeTiming` class. If the named `endMark` does not exist, an | |
| 136 | 136 | error will be thrown. | |
| 137 | 137 | ||
| 138 | - ### performance.nodeFrame | ||
| 139 | - <!-- YAML | ||
| 140 | - added: v8.5.0 | ||
| 141 | - --> | ||
| 142 | - | ||
| 143 | - * {PerformanceFrame} | ||
| 144 | - | ||
| 145 | - An instance of the `PerformanceFrame` class that provides performance metrics | ||
| 146 | - for the event loop. | ||
| 147 | - | ||
| 148 | 138 | ### performance.nodeTiming | |
| 149 | 139 | <!-- YAML | |
| 150 | 140 | added: v8.5.0 | |
@@ -268,37 +258,6 @@ The value may be one of: | |||
| 268 | 258 | * `perf_hooks.constants.NODE_PERFORMANCE_GC_INCREMENTAL` | |
| 269 | 259 | * `perf_hooks.constants.NODE_PERFORMANCE_GC_WEAKCB` | |
| 270 | 260 | ||
| 271 | - ## Class: PerformanceNodeFrame extends PerformanceEntry | ||
| 272 | - <!-- YAML | ||
| 273 | - added: v8.5.0 | ||
| 274 | - --> | ||
| 275 | - | ||
| 276 | - Provides timing details for the Node.js event loop. | ||
| 277 | - | ||
| 278 | - ### performanceNodeFrame.frameCheck | ||
| 279 | - | ||
| 280 | - The high resolution timestamp when `uv_check_t` processing occurred on the | ||
| 281 | - current loop. | ||
| 282 | - | ||
| 283 | - ### performanceNodeFrame.frameCount | ||
| 284 | - | ||
| 285 | - The total number of event loop iterations (iterated when `uv_idle_t` | ||
| 286 | - processing occurrs). | ||
| 287 | - | ||
| 288 | - ### performanceNodeFrame.frameIdle | ||
| 289 | - | ||
| 290 | - The high resolution timestamp when `uv_idle_t` processing occurred on the | ||
| 291 | - current loop. | ||
| 292 | - | ||
| 293 | - ### performanceNodeFrame.framesPerSecond | ||
| 294 | - | ||
| 295 | - The number of event loop iterations per second. | ||
| 296 | - | ||
| 297 | - ### performanceNodeFrame.framePrepare | ||
| 298 | - | ||
| 299 | - The high resolution timestamp when `uv_prepare_t` processing occurred on the | ||
| 300 | - current loop. | ||
| 301 | - | ||
| 302 | 261 | ## Class: PerformanceNodeTiming extends PerformanceEntry | |
| 303 | 262 | <!-- YAML | |
| 304 | 263 | added: v8.5.0 | |
0 commit comments