Commit 7d0c869
doc: add PerformanceObserver buffered document
The option buffered is not about queueing the PerformanceEntrys with
an event loop task or not. The option buffered in the spec is about
filling the observer with the global PerformanceEntry buffer. The
current (and the spec) behavior is different with Node.js
version <= v16.0.0.
PR-URL: #39514
Refs: https://w3c.github.io/performance-timeline/#observe-method
Refs: https://nodejs.org/dist/latest-v14.x/docs/api/perf_hooks.html#perf_hooks_performanceobserver_observe_options
Refs: #39297
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>1 parent 64c02eb commit 7d0c869
1 file changed
Lines changed: 8 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -585,6 +585,10 @@ Disconnects the `PerformanceObserver` instance from all notifications. | |||
| 585 | 585 | <!-- YAML | |
| 586 | 586 | added: v8.5.0 | |
| 587 | 587 | changes: | |
| 588 | + - version: REPLACEME | ||
| 589 | + pr-url: https://github.com/nodejs/node/pull/39297 | ||
| 590 | + description: Updated to conform to Performance Timeline Level 2. The | ||
| 591 | + buffered option has been added back. | ||
| 588 | 592 | - version: v16.0.0 | |
| 589 | 593 | pr-url: https://github.com/nodejs/node/pull/37136 | |
| 590 | 594 | description: Updated to conform to User Timing Level 3. The | |
@@ -597,6 +601,10 @@ changes: | |||
| 597 | 601 | * `entryTypes` {string[]} An array of strings identifying the types of | |
| 598 | 602 | {PerformanceEntry} instances the observer is interested in. If not | |
| 599 | 603 | provided an error will be thrown. | |
| 604 | + * `buffered` {boolean} If true, the observer callback is called with a | ||
| 605 | + list global `PerformanceEntry` buffered entries. If false, only | ||
| 606 | + `PerformanceEntry`s created after the time point are sent to the | ||
| 607 | + observer callback. **Default:** `false`. | ||
| 600 | 608 | ||
| 601 | 609 | Subscribes the {PerformanceObserver} instance to notifications of new | |
| 602 | 610 | {PerformanceEntry} instances identified either by `options.entryTypes` | |
0 commit comments