Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
doc: make perf_hooks Extends usage consistent
The docs use `* Extends: {type}` to define inheritance. This
commit updates the perf_hooks documentation to be consistent.

PR-URL: #33777
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
cjihrig committed Jun 9, 2020
1 parent 2e49010 commit 85dbd17
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion doc/api/perf_hooks.md
Expand Up @@ -255,11 +255,13 @@ The value may be one of:
* `perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_ALL_EXTERNAL_MEMORY`
* `perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_SCHEDULE_IDLE`

## Class: `PerformanceNodeTiming extends PerformanceEntry`
## Class: `PerformanceNodeTiming`
<!-- YAML
added: v8.5.0
-->

* Extends: {PerformanceEntry}

_This property is an extension by Node.js. It is not available in Web browsers._

Provides timing details for Node.js itself. The constructor of this class
Expand Down
2 changes: 1 addition & 1 deletion tools/doc/type-parser.js
Expand Up @@ -134,7 +134,7 @@ const customTypesMap = {
'Histogram': 'perf_hooks.html#perf_hooks_class_histogram',
'PerformanceEntry': 'perf_hooks.html#perf_hooks_class_performanceentry',
'PerformanceNodeTiming':
'perf_hooks.html#perf_hooks_class_performancenodetiming_extends_performanceentry', // eslint-disable-line max-len
'perf_hooks.html#perf_hooks_class_performancenodetiming',
'PerformanceObserver':
'perf_hooks.html#perf_hooks_class_perf_hooks_performanceobserver',
'PerformanceObserverEntryList':
Expand Down

0 comments on commit 85dbd17

Please sign in to comment.