MessageEvent()

MessageEvent() コンストラクターは新しい MessageEvent オブジェクトのインスタンスを作成します。

構文

new MessageEvent(type)
new MessageEvent(type, options)

引数

type

文字列で、このイベントの名前を示します。 大文字と小文字を区別し、ブラウザーは常に message を設定します。

options 省略可

Event() で定義されたプロパティに加え、以下のプロパティを持つことができるオブジェクトです。

data 省略可

MessageEvent に含めたいデータ。 これは任意のデータ型であり、指定しない場合は既定で null になります。

origin 省略可

文字列で、メッセージの発信元を表します。 指定しなかった場合の既定値は空文字列 ("") です。

lastEventId 省略可

文字列で、このイベントの一意な ID を表します。 指定しなかった場合の既定値は空文字列 ("") です。

source 省略可

メッセージの送信元を表す MessageEventSourceWindowMessagePortServiceWorker の何れかのオブジェクト)を指定します。設定されていない場合の既定値は null です。

ports 省略可

MessagePort オブジェクトの配列で、メッセージが(チャンネルメッセージングや共有ワーカーにメッセージを送信する場合など、適切な場合に)送信されるチャンネルに関連するポートを表します。 指定しない場合の既定値は空の配列 ([]) になります。

返値

新しい MessageEvent オブジェクトです。

const myMessage = new MessageEvent('message', {
  data : 'hello'
});

仕様書

Specification
HTML Standard
# the-messageevent-interface:dom-event-constructor

ブラウザーの互換性

BCD tables only load in the browser

関連情報

  • ExtendableMessageEvent — このインターフェイスに似ていますが、もっと柔軟性が必要なインターフェイスで使用されます。