CloseEvent: reason プロパティ

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.

reason は CloseEvent インターフェイスの読み取り専用プロパティで、サーバーが接続を閉じる際に示した WebSocket 接続が閉じた理由を返します。つまり、閉じたことについての簡潔で人間が読める散文的な説明です。

値

文字列です。

例

次の例では、 reason の値をコンソールに表示します。

js
WebSocket.onclose = (event) => {
  console.log(event.reason);
};

仕様書

Specification
WebSockets
# ref-for-dom-closeevent-reason②

ブラウザーの互換性

関連情報

  • RFC 6455（WebSocket プロトコル仕様書）