Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document durationThreshold in PerfObserver.observe() #21552

Merged
merged 1 commit into from
Oct 16, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions files/en-us/web/api/performanceobserver/observe/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,14 @@ observe(options)

- `options`

- : A `PerformanceObserverInit` dictionary with the following possible
members:
- : An object with the following possible members:

- `buffered`
- : A boolean flag to indicate whether buffered
entries should be queued into the observer's buffer. Must be used only with the
"`type`" option.
- `durationThreshold`
- : A {{domxref("DOMHighResTimeStamp")}} defining the threshold for {{domxref("PerformanceEventTiming")}} entries. Defaults to 104ms and is rounded to the nearest of 8ms. Lowest possible threshold is 16ms.
- `entryTypes`
- : An array of string objects, each
specifying one performance entry type to observe. May not be used together with
Expand All @@ -48,10 +53,6 @@ observe(options)
- : A single string specifying exactly one
performance entry type to observe. May not be used together with the
`entryTypes` option.
- `buffered`
- : A boolean flag to indicate whether buffered
entries should be queued into the observer's buffer. Must be used only with the
"`type`" option.

See {{domxref("PerformanceEntry.entryType")}} for a list of valid performance entry
type names. Unrecognized types are ignored, though the browser may output a warning
Expand Down