summaryrefslogtreecommitdiff
path: root/doc/api/perf_hooks.md
diff options
context:
space:
mode:
authorVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-04-14 14:38:02 +0300
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-04-15 02:37:50 +0300
commit715d7f31b384723b1fc4691cfd54a3e6a1a56bb8 (patch)
tree1b36c21587f35d65e127659f8e8b788c5fa529db /doc/api/perf_hooks.md
parent887f4c54ce843bfa2a63ad1135f15ab885546943 (diff)
downloadandroid-node-v8-715d7f31b384723b1fc4691cfd54a3e6a1a56bb8.tar.gz
android-node-v8-715d7f31b384723b1fc4691cfd54a3e6a1a56bb8.tar.bz2
android-node-v8-715d7f31b384723b1fc4691cfd54a3e6a1a56bb8.zip
doc: unify section structures
PR-URL: https://github.com/nodejs/node/pull/20028 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api/perf_hooks.md')
-rw-r--r--doc/api/perf_hooks.md108
1 files changed, 52 insertions, 56 deletions
diff --git a/doc/api/perf_hooks.md b/doc/api/perf_hooks.md
index a3c3b2eb36..c6c16954f4 100644
--- a/doc/api/perf_hooks.md
+++ b/doc/api/perf_hooks.md
@@ -340,12 +340,16 @@ The high resolution millisecond timestamp at which the V8 platform was
initialized.
-## Class: PerformanceObserver(callback)
+## Class: PerformanceObserver
+
+### new PerformanceObserver(callback)
<!-- YAML
added: v8.5.0
-->
-* `callback` {Function} A `PerformanceObserverCallback` callback function.
+* `callback` {Function}
+ * `list` {PerformanceObserverEntryList}
+ * `observer` {PerformanceObserver}
`PerformanceObserver` objects provide notifications when new
`PerformanceEntry` instances have been added to the Performance Timeline.
@@ -364,69 +368,16 @@ obs.observe({ entryTypes: ['mark'], buffered: true });
performance.mark('test');
```
-
Because `PerformanceObserver` instances introduce their own additional
performance overhead, instances should not be left subscribed to notifications
indefinitely. Users should disconnect observers as soon as they are no
longer needed.
-### Callback: PerformanceObserverCallback(list, observer)
-<!-- YAML
-added: v8.5.0
--->
-
-* `list` {PerformanceObserverEntryList}
-* `observer` {PerformanceObserver}
-
-The `PerformanceObserverCallback` is invoked when a `PerformanceObserver` is
+The `callback` is invoked when a `PerformanceObserver` is
notified about new `PerformanceEntry` instances. The callback receives a
`PerformanceObserverEntryList` instance and a reference to the
`PerformanceObserver`.
-### Class: PerformanceObserverEntryList
-<!-- YAML
-added: v8.5.0
--->
-
-The `PerformanceObserverEntryList` class is used to provide access to the
-`PerformanceEntry` instances passed to a `PerformanceObserver`.
-
-#### performanceObserverEntryList.getEntries()
-<!-- YAML
-added: v8.5.0
--->
-
-* Returns: {PerformanceEntry[]}
-
-Returns a list of `PerformanceEntry` objects in chronological order
-with respect to `performanceEntry.startTime`.
-
-#### performanceObserverEntryList.getEntriesByName(name[, type])
-<!-- YAML
-added: v8.5.0
--->
-
-* `name` {string}
-* `type` {string}
-* Returns: {PerformanceEntry[]}
-
-Returns a list of `PerformanceEntry` objects in chronological order
-with respect to `performanceEntry.startTime` whose `performanceEntry.name` is
-equal to `name`, and optionally, whose `performanceEntry.entryType` is equal to
-`type`.
-
-#### performanceObserverEntryList.getEntriesByType(type)
-<!-- YAML
-added: v8.5.0
--->
-
-* `type` {string}
-* Returns: {PerformanceEntry[]}
-
-Returns a list of `PerformanceEntry` objects in chronological order
-with respect to `performanceEntry.startTime` whose `performanceEntry.entryType`
-is equal to `type`.
-
### performanceObserver.disconnect()
<!-- YAML
added: v8.5.0
@@ -482,6 +433,51 @@ for (let n = 0; n < 3; n++)
performance.mark(`test${n}`);
```
+## Class: PerformanceObserverEntryList
+<!-- YAML
+added: v8.5.0
+-->
+
+The `PerformanceObserverEntryList` class is used to provide access to the
+`PerformanceEntry` instances passed to a `PerformanceObserver`.
+
+### performanceObserverEntryList.getEntries()
+<!-- YAML
+added: v8.5.0
+-->
+
+* Returns: {PerformanceEntry[]}
+
+Returns a list of `PerformanceEntry` objects in chronological order
+with respect to `performanceEntry.startTime`.
+
+### performanceObserverEntryList.getEntriesByName(name[, type])
+<!-- YAML
+added: v8.5.0
+-->
+
+* `name` {string}
+* `type` {string}
+* Returns: {PerformanceEntry[]}
+
+Returns a list of `PerformanceEntry` objects in chronological order
+with respect to `performanceEntry.startTime` whose `performanceEntry.name` is
+equal to `name`, and optionally, whose `performanceEntry.entryType` is equal to
+`type`.
+
+### performanceObserverEntryList.getEntriesByType(type)
+<!-- YAML
+added: v8.5.0
+-->
+
+* `type` {string}
+* Returns: {PerformanceEntry[]}
+
+Returns a list of `PerformanceEntry` objects in chronological order
+with respect to `performanceEntry.startTime` whose `performanceEntry.entryType`
+is equal to `type`.
+
+
## Examples
### Measuring the duration of async operations