Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

perf_hooks: remove docs for unimplemented API #15641

Closed
wants to merge 1 commit into from
Closed

perf_hooks: remove docs for unimplemented API #15641

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 0 additions & 41 deletions doc/api/perf_hooks.md
View file
Open in desktop
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