Performance: mark() Methode

Syntax

mark(name)
mark(name, markOptions)

Parameter

name

Ein String, der den Namen des Marks darstellt. Darf nicht derselbe Name sein wie einer der Eigenschaften des veralteten PerformanceTiming-Interfaces.

markOptions Optional

Ein Objekt zur Spezifikation eines Zeitstempels und zusätzlicher Metadaten für das Mark.

detail Optional

Beliebige Metadaten, die im Mark enthalten sein sollen. Standardmäßig null. Muss strukturierbar kopierbar sein.

startTime Optional

DOMHighResTimeStamp, der als Mark-Zeit verwendet werden soll. Standardmäßig performance.now().

Rückgabewert

Der erstellte PerformanceMark-Eintrag.

Ausnahmen

• SyntaxError: Wird ausgelöst, wenn name einer der Eigenschaften des veralteten PerformanceTiming-Interfaces ist. Siehe das Beispiel unten.
• TypeError: Wird ausgelöst, wenn startTime negativ ist.

Beispiele

Erstellen benannter Marker

Das folgende Beispiel verwendet mark(), um benannte PerformanceMark-Einträge zu erstellen. Sie können mehrere Marks mit demselben Namen erstellen. Sie können ihnen auch zuweisen, um eine Referenz auf das erstellte PerformanceMark-Objekt zu haben.

performance.mark("login-started");
performance.mark("login-started");
performance.mark("login-finished");
performance.mark("form-sent");

const videoMarker = performance.mark("video-loaded");

Erstellen von Markern mit Details

Das Performance-Mark ist konfigurierbar mit dem markOptions-Objekt, in dem Sie zusätzliche Informationen in der detail-Eigenschaft platzieren können, die von jedem Typ sein kann.

performance.mark("login-started", {
  detail: "Login started using the login button in the top menu.",
});

performance.mark("login-started", {
  detail: { htmlElement: myElement.id },
});

Erstellen von Markern mit einer anderen Startzeit

Der Standard-Zeitstempel der mark()-Methode ist performance.now(). Sie können ihn mithilfe der startTime-Option in markOptions auf eine andere Zeit setzen.

performance.mark("start-checkout", {
  startTime: 20.0,
});

performance.mark("login-button-pressed", {
  startTime: myEvent.timeStamp,
});

Reservierte Namen

Beachten Sie, um die Abwärtskompatibilität zu wahren, können Namen, die Teil des veralteten PerformanceTiming-Interfaces sind, nicht verwendet werden. Das folgende Beispiel führt zu einem Fehler:

performance.mark("navigationStart");
// SyntaxError: "navigationStart" is part of
// the PerformanceTiming interface,
// and cannot be used as a mark name

Spezifikationen

Browser-Kompatibilität