ContextQMD
Back to Content

PerformanceMark

files/en-us/web/api/performancemark/index.md

latest2.4 KB
Original Source

{{APIRef("Performance API")}}{{AvailableInWorkers}}

PerformanceMark is an interface for {{domxref("PerformanceEntry")}} objects with an {{domxref("PerformanceEntry.entryType","entryType")}} of "mark".

Entries of this type are typically created by calling {{domxref("Performance.mark","performance.mark()")}} to add a named {{domxref("DOMHighResTimeStamp")}} (the mark) to the browser's performance timeline. To create a performance mark that isn't added to the browser's performance timeline, use the constructor.

{{InheritanceDiagram}}

Constructor

  • {{domxref("PerformanceMark.PerformanceMark", "PerformanceMark()")}}
    • : Creates a new PerformanceMark object that isn't added to the browser's performance timeline.

Instance properties

  • {{domxref("PerformanceMark.detail")}}
    • : Contains arbitrary metadata about the measure.

This interface extends the following {{domxref("PerformanceEntry")}} properties by qualifying/constraining the properties as follows:

  • {{domxref("PerformanceEntry.entryType")}} {{ReadOnlyInline}}
    • : Returns "mark".
  • {{domxref("PerformanceEntry.name")}} {{ReadOnlyInline}}
    • : Returns the name given to the mark when it was created via a call to {{domxref("Performance.mark()","performance.mark()")}}.
  • {{domxref("PerformanceEntry.startTime")}} {{ReadOnlyInline}}
    • : Returns the {{domxref("DOMHighResTimeStamp")}} when {{domxref("Performance.mark()","performance.mark()")}} was called.
  • {{domxref("PerformanceEntry.duration")}} {{ReadOnlyInline}}
    • : Returns 0. (A mark has no duration.)

Instance methods

This interface has no methods.

Example

See the example in Using the User Timing API.

Chrome DevTools uses performance.mark() and in particular a structured detail property as part of its extensibility API that surfaces these in custom tracks in performance traces. See the example in Performance: mark() method page and the Chrome's extensibility API documentation for more information and examples.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also