1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

perf_hooks: remove docs for unimplemented API

Browse Source 
The node frame (aka loop) timing API did not land, it depends on
https://github.com/libuv/libuv/pull/1489 which is still a WIP.

See: https://github.com/nodejs/node/pull/14680#discussion_r140605664

PR-URL: https://github.com/nodejs/node/pull/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>
This commit is contained in:
Sam Roberts 2017-09-27 12:28:21 -07:00 committed by James M Snell
parent 09b703bd3c
commit dd83b5f2ac
1 changed files with 0 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/api/perf_hooks.md
View File

@ -135,16 +135,6 @@ the Performance Timeline or any of the timestamp properties provided by the
`PerformanceNodeTiming` class. If the named `endMark` does not exist, an
error will be thrown.
### performance.nodeFrame
<!-- YAML
added: v8.5.0
-->
* {PerformanceFrame}
An instance of the `PerformanceFrame` class that provides performance metrics
for the event loop.
### performance.nodeTiming
<!-- YAML
added: v8.5.0
@ -268,37 +258,6 @@ The value may be one of:
* `perf_hooks.constants.NODE_PERFORMANCE_GC_INCREMENTAL`
* `perf_hooks.constants.NODE_PERFORMANCE_GC_WEAKCB`
## Class: PerformanceNodeFrame extends PerformanceEntry
<!-- YAML
added: v8.5.0
-->
Provides timing details for the Node.js event loop.
### performanceNodeFrame.frameCheck
The high resolution timestamp when `uv_check_t` processing occurred on the
current loop.
### performanceNodeFrame.frameCount
The total number of event loop iterations (iterated when `uv_idle_t`
processing occurrs).
### performanceNodeFrame.frameIdle
The high resolution timestamp when `uv_idle_t` processing occurred on the
current loop.
### performanceNodeFrame.framesPerSecond
The number of event loop iterations per second.
### performanceNodeFrame.framePrepare
The high resolution timestamp when `uv_prepare_t` processing occurred on the
current loop.
## Class: PerformanceNodeTiming extends PerformanceEntry
<!-- YAML
added: v8.5.0