performance.mark()
The mark()
method creates a
timestamp
in the browser's performance entry
buffer with the given name.
The application defined timestamp can also be retrieved by one of the
Performance
interface's getEntries*()
methods
(getEntries()
,
getEntriesByName()
or
getEntriesByType()
).
The mark()'s
stores its data internally as
PerformanceEntry
.
Note: This feature is available in Web Workers
Syntax
performance.mark(name);
performance.mark(measureName, markOptions)
Arguments
- name
-
A
DOMString
representing the name of the mark. If thename
given to this method already exists in thePerformanceTiming
interface,SyntaxError
is thrown. markOptions
Optional-
An object for specifying a timestamp and additional metadata for the mark.
detail
-
Arbitrary metadata to include in the mark.
startTime
-
DOMHighResTimeStamp
to use as the mark time.
Return value
- entry
-
The
PerformanceMark
entry that was created.
Example
The following example shows how to use mark()
to create and retrieve
PerformanceMark
entries.
// Create a bunch of marks.
performance.mark("squirrel");
performance.mark("squirrel");
performance.mark("monkey");
performance.mark("monkey");
performance.mark("dog");
performance.mark("dog");
// Get all of the PerformanceMark entries.
const allEntries = performance.getEntriesByType("mark");
console.log(allEntries.length);
// 6
// Get all of the "monkey" PerformanceMark entries.
const monkeyEntries = performance.getEntriesByName("monkey");
console.log(monkeyEntries.length);
// 2
// Clear out all of the marks.
performance.clearMarks();
Specifications
Specification |
---|
User Timing # dom-performance-mark |
Browser compatibility
BCD tables only load in the browser