WebSocket: close イベント
Baseline
広く利用可能
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2015年7月以降、すべてのブラウザーで利用可能です。
メモ: この機能はウェブワーカー内で利用可能です。
close イベントは、 WebSocket の接続が閉じられたときに発生します。
構文
イベント名を addEventListener() などのメソッドで使用するか、イベントハンドラープロパティを設定するかしてください。
js
addEventListener("close", (event) => {});
onclose = (event) => {};
イベント型
CloseEvent です。 Event から継承しています。
イベントプロパティ
下記に示したプロパティに加えて、親インターフェイスである Event からのプロパティが利用できます。
例
接続が閉じられる時が分かれば、 UI を更新させたり、閉じた接続についてのデータを保存したりすることができます。以下の例では exampleSocket と呼ばれる変数が開かれた WebSocket を参照しており、このハンドラーが、ソケットが閉じられた場面を扱います。
js
exampleSocket.addEventListener("close", (event) => {
console.log("この接続を閉じることに成功しました。");
});
同じことを、イベントハンドラープロパティを用いて行うこともできます。
js
exampleSocket.onclose = (event) => {
console.log("この接続を閉じることに成功しました。");
};
仕様書
| 仕様書 |
|---|
| WebSockets # dom-websocket-onclose |