WebSocket: close イベント

Baseline Widely available

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

メモ: この機能はウェブワーカー内で利用可能です。

close イベントは、 WebSocket の接続が閉じられたときに発生します。

構文

イベント名を addEventListener() などのメソッドで使用するか、イベントハンドラープロパティを設定するかしてください。

addEventListener("close", (event) => {});

onclose = (event) => {};

CloseEvent です。 Event から継承しています。

下記に示したプロパティに加えて、親インターフェイスである Event からのプロパティが利用できます。

接続が閉じられる時が分かれば、 UI を更新させたり、閉じた接続についてのデータを保存したりすることができます。以下の例では exampleSocket と呼ばれる変数が開かれた WebSocket を参照しており、このハンドラーが、ソケットが閉じられた場面を扱います。

exampleSocket.addEventListener("close", (event) => {
  console.log("この接続を閉じることに成功しました。");
});

同じことを、イベントハンドラープロパティを用いて行うこともできます。

exampleSocket.onclose = (event) => {
  console.log("この接続を閉じることに成功しました。");
};

Specification
WebSockets # dom-websocket-onclose