Performance

High Resolution Time — Performance interface Source: High Resolution Time (https://w3c.github.io/hr-time/) Performance Timeline (https://w3c.github.io/performance-timeline/) User Timing (https://w3c.github.io/user-timing/) Extracted from: w3c/webref ed/idl/hr-time.idl, performance-timeline.idl, user-timing.idl

Module: wintercg.performance Support: Experimental

Type Aliases

  • DOMHighResTimeStamp

Dictionary PerformanceMarkOptions

Options for creating a PerformanceMark.

Since: 1.1.0 Docs: WinterCG Docs

2 members: 2 undocumented

Properties

⚪ detail
Options for creating a PerformanceMark.
⚪ startTime
A custom start time for the mark; defaults to `performance.now()`.

---

Dictionary PerformanceMeasureOptions

Options for creating a PerformanceMeasure.

Since: 1.1.0 Docs: WinterCG Docs

4 members: 4 undocumented

Properties

⚪ detail
Options for creating a PerformanceMark.
⚪ start
A custom detail value to attach to the mark (structured-cloned).
⚪ end
The start point: a mark name or a DOMHighResTimeStamp.
⚪ duration
The end point: a mark name or a DOMHighResTimeStamp.

---

Dictionary PerformanceObserverInit

Options for configuring a PerformanceObserver.

Since: 1.1.0 Docs: WinterCG Docs

3 members: 3 undocumented

Properties

⚪ entryTypes
A list of entry types to observe (mutually exclusive with `type`).
⚪ type
A list of entry types to observe (mutually exclusive with `type`).
⚪ buffered
If true, deliver existing matching entries immediately upon observe().

---

Callback PerformanceObserverCallback

Callback invoked when observed performance entries are available.

Since: 1.1.0 Docs: WinterCG Docs

---

Interface PerformanceEntry

A single performance metric recorded by the browser or application.

Since: 1.1.0 Docs: WinterCG Docs

5 members: 5 undocumented

Methods

⚪ toJSON()
Returns a JSON representation of this entry.

Properties

⚪ name
A custom detail value to attach to the measure (structured-cloned).
⚪ entryType
The type of the entry (e.g. `"mark"`, `"measure"`).
⚪ startTime
A custom start time for the mark; defaults to `performance.now()`.
⚪ duration
The end point: a mark name or a DOMHighResTimeStamp.

---

Interface PerformanceMark

A user-defined performance mark created via performance.mark().

Extends: PerformanceEntry Since: 1.1.0 Docs: WinterCG Docs

2 members: 2 undocumented

Constructors

⚪ constructor(markName, markOptions)
string, PerformanceMarkOptions

Properties

⚪ detail
Options for creating a PerformanceMark.

---

Interface PerformanceMeasure

A user-defined performance measure created via performance.measure().

Extends: PerformanceEntry Since: 1.1.0 Docs: WinterCG Docs

1 members: 1 undocumented

Properties

⚪ detail
Options for creating a PerformanceMark.

---

Interface PerformanceObserverEntryList

Callback invoked when observed performance entries are available.

Since: 1.1.0 Docs: WinterCG Docs

3 members: 3 undocumented

Methods

⚪ getEntries()
→ sequence
⚪ getEntriesByName(name, type)
→ sequence
⚪ getEntriesByType(type)
→ sequence

---

Interface PerformanceObserver

Observes performance entry notifications and delivers them asynchronously via callback.

Since: 1.1.0 Docs: WinterCG Docs

5 members: 5 undocumented

Constructors

⚪ constructor(callback)
PerformanceObserverCallback

Methods

⚪ observe(options)
Options for configuring a PerformanceObserver.
⚪ disconnect()
Stop observing and discard any pending entries.
⚪ takeRecords()
→ sequence

Properties

⚪ supportedEntryTypes
A frozen array of entry type strings supported by the implementation.

---

Interface Performance

Provides access to high-resolution timing and performance metrics.

Extends: wintercg.EventTarget Since: 1.1.0 Docs: WinterCG Docs

10 members: 10 undocumented

Methods

⚪ now()
A custom detail value to attach to the mark (structured-cloned).
⚪ mark(markName, markOptions)
Options for creating a PerformanceMark.
⚪ measure(measureName, startOrMeasureOptions, endMark)
Options for creating a PerformanceMeasure.
⚪ getEntries()
→ sequence
⚪ getEntriesByName(name, type)
→ sequence
⚪ getEntriesByType(type)
→ sequence
⚪ clearMarks(markName)
Removes all marks, or only marks with the given name.
⚪ clearMeasures(measureName)
Removes all measures, or only measures with the given name.
⚪ toJSON()
Returns a JSON representation of this entry.

Properties

⚪ timeOrigin
The high-resolution timestamp at which the global context was created.

---