Skip to content

Commit

Permalink
perf_hooks: remove docs for unimplemented API
Browse files Browse the repository at this point in the history
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 <[email protected]>
Reviewed-By: Timothy Gu <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
  • Loading branch information
sam-github authored and jasnell committed Sep 29, 2017
1 parent 09b703b commit dd83b5f
Showing 1 changed file with 0 additions and 41 deletions.
41 changes: 0 additions & 41 deletions doc/api/perf_hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit dd83b5f

Please sign in to comment.