performance.getEntriesByName()
The getEntriesByName()
method returns a list of
PerformanceEntry
objects for the given name and type.
The list's members (entries) can be created by making performance
marks or measures (for example by calling the
mark()
method) at explicit points in time.
Note: This feature is available in Web Workers
Syntax
entries = window.performance.getEntriesByName(name, type);
Arguments
- name
-
The name of the entry to retrieve.
- type Optional
-
The type of entry to retrieve such as "
mark
". The valid entry types are listed inPerformanceEntry.entryType
.
Return value
- entries
-
A list of
PerformanceEntry
objects that have the specifiedname
andtype
. If thetype
argument is not specified, only thename
will be used to determine the entries to return. The items will be in chronological order based on the entries'startTime
. If no objects meet the specified criteria, an empty list is returned.
Example
function use_PerformanceEntry_methods() {
log("PerformanceEntry tests ...");
if (performance.mark === undefined) {
log("... performance.mark Not supported");
return;
}
// Create some performance entries via the mark() method
performance.mark("Begin");
do_work(50000);
performance.mark("End");
performance.mark("Begin");
do_work(100000);
performance.mark("End");
do_work(200000);
performance.mark("End");
// Use getEntries() to iterate through the each entry
var p = performance.getEntries();
for (var i=0; i < p.length; i++) {
log("Entry[" + i + "]");
check_PerformanceEntry(p[i]);
}
// Use getEntries(name, entryType) to get specific entries
p = performance.getEntries({name : "Begin", entryType: "mark"});
for (var i=0; i < p.length; i++) {
log("Begin[" + i + "]");
check_PerformanceEntry(p[i]);
}
// Use getEntriesByType() to get all "mark" entries
p = performance.getEntriesByType("mark");
for (var i=0; i < p.length; i++) {
log ("Mark only entry[" + i + "]: name = " + p[i].name +
"; startTime = " + p[i].startTime +
"; duration = " + p[i].duration);
}
// Use getEntriesByName() to get all "mark" entries named "Begin"
p = performance.getEntriesByName("Begin", "mark");
for (var i=0; i < p.length; i++) {
log ("Mark and Begin entry[" + i + "]: name = " + p[i].name +
"; startTime = " + p[i].startTime +
"; duration = " + p[i].duration);
}
}
Specifications
Specification |
---|
Performance Timeline # dom-performance-getentriesbyname |
Browser compatibility
BCD tables only load in the browser