Производительность: метод mark()

Метод mark() создает именованный объект PerformanceMark, представляющий собой маркер отметки времени с высоким разрешением на временной шкале производительности браузера.

name

Строка, представляющая имя отметки. Не должно совпадать с именем одного из свойств устаревшего интерфейса PerformanceTiming.

markOptions Необязательно

Объект для указания отметки времени и дополнительной метаданных для отметки.

detail Необязательно

Произвольные метаданные, которые нужно включить в отметку. По умолчанию null. Должны быть структурируемо клонируемыми.

startTime Необязательно

DOMHighResTimeStamp для использования в качестве времени отметки. По умолчанию performance.now().

Элемент PerformanceMark, который был создан.

• SyntaxError: Бросается, если имя name совпадает с именем одного из свойств устаревшего интерфейса PerformanceTiming. См. пример ниже .
• TypeError: Бросается, если значение startTime отрицательное.

В следующем примере используется mark() для создания именованных элементов PerformanceMark. Вы можете создать несколько маркеров с одинаковым именем. Вы также можете присвоить их, чтобы иметь ссылку на объект PerformanceMark, который был создан.

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

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

Маркер производительности настраивается с помощью объекта markOptions, где вы можете добавить дополнительную информацию в свойство detail, которое может быть любого типа.

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

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

Значение по умолчанию для отметки времени в методе mark() — performance.now(). Вы можете задать другое время, используя параметр startTime в markOptions.

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

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

Для обеспечения обратной совместимости нельзя использовать имена, которые являются частью устаревшего интерфейса PerformanceTiming. В следующем примере возникает ошибка:

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