WebSocket: message イベント
message イベントは、 WebSocket を通してデータを受け取ったときに発生します。
構文
イベント名を addEventListener() などのメソッドで使用するか、イベントハンドラープロパティを設定するかしてください。
js
addEventListener('message', (event) => { })
onmessage = (event) => { }
イベント型
MessageEvent です。 Event から継承しています。
イベントプロパティ
以下に示したプロパティに加え、親インターフェイスである Event から継承したプロパティも利用できます。
data読取専用-
メッセージ送信者から送信されたデータです。
origin読取専用-
文字列で、メッセージ送信者のオリジンを表します。
lastEventId読取専用-
文字列で、このイベントの固有の ID を表します。
source読取専用-
MessageEventSource(Window,MessagePort,ServiceWorkerオブジェクトが成ることができる)で、メッセージ送信者を表します。 ports読取専用-
MessagePortオブジェクトの配列で、メッセージが送信されるチャネルに関連するポートを表します(チャネルメッセージングや共有ワーカーにメッセージを送信する場合など、適切な場合)。
例
js
// Create WebSocket connection.
const socket = new WebSocket('ws://localhost:8080');
// Listen for messages
socket.addEventListener('message', (event) => {
console.log('Message from server ', event.data);
});
仕様書
| Specification |
|---|
| WebSockets Standard # dom-websocket-onmessage |
ブラウザーの互換性
BCD tables only load in the browser