Skip to content

Commit 05e6a59

Browse files
committed
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: nodejs#14680 (comment)
1 parent 93985ef commit 05e6a59

File tree

1 file changed

+0
-41
lines changed

1 file changed

+0
-41
lines changed

doc/api/perf_hooks.md

-41
Original file line numberDiff line numberDiff line change
@@ -135,16 +135,6 @@ the Performance Timeline or any of the timestamp properties provided by the
135135
`PerformanceNodeTiming` class. If the named `endMark` does not exist, an
136136
error will be thrown.
137137

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-
148138
### performance.nodeTiming
149139
<!-- YAML
150140
added: v8.5.0
@@ -268,37 +258,6 @@ The value may be one of:
268258
* `perf_hooks.constants.NODE_PERFORMANCE_GC_INCREMENTAL`
269259
* `perf_hooks.constants.NODE_PERFORMANCE_GC_WEAKCB`
270260

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-
302261
## Class: PerformanceNodeTiming extends PerformanceEntry
303262
<!-- YAML
304263
added: v8.5.0

0 commit comments

Comments
 (0)