PerformanceEntry: name property

Note: This feature is available in Web Workers.

The read-only name property of the PerformanceEntry interface is a string representing the name for a performance entry. It acts as an identifier, but it does not have to be unique. The value depends on the subclass.

Value

A string. The value depends on the subclass of the PerformanceEntry object as shown by the table below.

SubclassValue
InteractionContentfulPaintAlways returns an empty string.
LargestContentfulPaintAlways returns an empty string.
LayoutShiftAlways returns "layout-shift".
PerformanceElementTimingOne of the following strings:
  • "image-paint"
  • "text-paint"
PerformanceEventTimingThe associated event's type.
PerformanceLongAnimationFrameTimingAlways returns "long-animation-frame".
PerformanceLongTaskTimingOne of the following strings:
  • "cross-origin-ancestor"
  • "cross-origin-descendant"
  • "cross-origin-unreachable"
  • "multiple-contexts"
  • "same-origin-ancestor"
  • "same-origin-descendant"
  • "same-origin"
  • "self"
  • "unknown"
PerformanceMarkThe name used when the mark was created by calling performance.mark().
PerformanceMeasureThe name used when the measure was created by calling performance.measure().
PerformanceNavigationTimingThe resolved URL of the requested resource. Note that this omits any text fragments or other fragment directives. The value doesn't change even if the request is redirected.
PerformancePaintTimingOne of the following strings:
  • "first-paint"
  • "first-contentful-paint"
PerformanceResourceTimingThe resolved URL of the requested resource. This value doesn't change even if the request is redirected.
PerformanceSoftNavigationThe new URL navigated to.
TaskAttributionTimingAlways returns "unknown".
VisibilityStateEntryOne of the following strings:
  • "visible"
  • "hidden"

Examples

undefined

Filtering performance entries by name

When the PerformanceEntry is a PerformanceResourceTiming object, the name property refers to the resolved URL of the requested resource. In this case, the name property can be useful to filter out specific resources, for example all SVG images.

js
// Log durations of SVG resources
performance.getEntriesByType("resource").forEach((entry) => {
  if (entry.name.endsWith(".svg")) {
    console.log(`${entry.name}'s duration: ${entry.duration}`);
  }
});

Getting performance entries by name

Both Performance and PerformanceObserver provide methods that allow you to get performance entries by name directly. You don't necessarily need the name property for that, instead you might use Performance.getEntriesByName() or PerformanceObserverEntryList.getEntriesByName().

js
// Log all marks named "debug-marks" at this point in time
const debugMarks = performance.getEntriesByName("debug-mark", "mark");
debugMarks.forEach((entry) => {
  console.log(`${entry.name}'s startTime: ${entry.startTime}`);
});

// PerformanceObserver version
// Log all marks named "debug-marks" when they happen
function perfObserver(list, observer) {
  list.getEntriesByName("debug-mark", "mark").forEach((entry) => {
    console.log(`${entry.name}'s startTime: ${entry.startTime}`);
  });
}
const observer = new PerformanceObserver(perfObserver);
observer.observe({ entryTypes: ["measure", "mark"] });

Specifications

See also