From 85dbd17bde1049022854581d09dc7d48fc6e6d24 Mon Sep 17 00:00:00 2001 From: cjihrig Date: Sat, 6 Jun 2020 16:48:02 -0400 Subject: [PATCH] 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: https://github.com/nodejs/node/pull/33777 Reviewed-By: Rich Trott Reviewed-By: Luigi Pinca --- doc/api/perf_hooks.md | 4 +++- tools/doc/type-parser.js | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/api/perf_hooks.md b/doc/api/perf_hooks.md index c2d301006e21d6..5e573d038b869e 100644 --- a/doc/api/perf_hooks.md +++ b/doc/api/perf_hooks.md @@ -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` +* 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 diff --git a/tools/doc/type-parser.js b/tools/doc/type-parser.js index d77fd420d1ae26..dda2fe02d289ac 100644 --- a/tools/doc/type-parser.js +++ b/tools/doc/type-parser.js @@ -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':