web api instance method
Performance: getEntriesByType() method
Available in workers
The getEntriesByType() method returns an array of PerformanceEntry objects currently present in the performance timeline for a given type.
If you are interested in performance entries of certain name, see getEntriesByName(). For all performance entries, see getEntries().
[!NOTE] This method does not notify you about new performance entries; you will only get entries that are present in the performance timeline at the time you call this method. To receive notifications about entries as they become available, use a
PerformanceObserver.
The following entry types are not supported by this method at all and won’t be returned even if entries for these types might exist:
"element"(PerformanceElementTiming)"event"(PerformanceEventTiming)"largest-contentful-paint"(LargestContentfulPaint)"layout-shift"(LayoutShift)"longtask"(PerformanceLongTaskTiming)
To access entries of these types, you must use a PerformanceObserver instead.
Syntax
getEntriesByType(type)
Parameters
type- : The type of entry to retrieve such as
"mark". The valid entry types are listed inentryType. The supportedentryTypescan be retrieved using the static propertyPerformanceObserver.supportedEntryTypes.
- : The type of entry to retrieve such as
Return value
An Array of PerformanceEntry objects that have the specified type. The items will be in chronological order based on the entries’ startTime. If no objects have the specified type, or no argument is provided, an empty array is returned.
Examples
Logging resource entries
The following example logs all entries with the type "resource".
const resources = performance.getEntriesByType("resource");
resources.forEach((entry) => {
console.log(`${entry.name}'s startTime: ${entry.startTime}`);
});