PerformanceMark: PerformanceMark() コンストラクター

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2015.

PerformanceMark() コンストラクターは、指定された名前のタイムスタンプを作成します。

performance.mark() とは異なり、コンストラクターが作成するパフォーマンスマークはブラウザーのパフォーマンスタイムラインに追加されません。つまり、Performance インターフェイスの getEntries*() メソッド（getEntries()、getEntriesByName()、getEntriesByType()）を呼び出しても、これらのマークの項目は表示されません。

構文

js
new PerformanceMark(name)
new PerformanceMark(name, markOptions)

引数

name

文字列で、マークの名前を表します。

markOptions 省略可

オブジェクトで、タイムスタンプとマークの追加メタデータを指定します。

detail 省略可

マークに記載する任意のメタデータ。既定値は null です。

startTime 省略可

DOMHighResTimeStamp で、マークの時刻として使用されます。既定値は performance.now() です。

返値

PerformanceMark オブジェクトです。

例外

  • SyntaxError: Thrown このメソッドに指定された name が、PerformanceTiming インターフェイスにすでに存在する場合に発生します。
  • TypeError: startTime が負の数の場合に発生します。

例外

次の例は、パフォーマンス項目がどのように構成され、ブラウザーのパフォーマンスタイムラインの一部にならないことを示しています。

js
new PerformanceMark("squirrel");
new PerformanceMark("monkey");
new PerformanceMark("dog");

const allEntries = performance.getEntriesByType("mark");
console.log(allEntries.length);
// 0

仕様書

Specification
User Timing
# dom-performancemark-constructor

ブラウザーの互換性

BCD tables only load in the browser

関連情報