WebSocket: close 事件

Baseline 已廣泛支援

此特性已相當成熟,可在許多裝置和瀏覽器版本上使用。自 ⁨2015 年 7 月⁩以來,各瀏覽器均已提供此特性。

注意:此功能在 Web Workers 中可用。

WebSocket 連線關閉時,會觸發 close 事件。

語法

在諸如 addEventListener() 之類的方法中使用事件名稱,或設定事件處理程式屬性。

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

onclose = (event) => { }

事件型別

一個 CloseEvent 物件。繼承自 Event

Event CloseEvent

事件屬性

除了下面列出的屬性之外,父介面 Event 的屬性也可使用。

code 只讀

返回一個 unsigned short,包含伺服器傳送的關閉程式碼。

reason 只讀

返回一個字串,指示伺服器關閉連線的原因。這特定於特定的伺服器和子協議。

wasClean 只讀

返回一個布林值,指示連線是否已正常關閉。

示例

您可能想知道連線何時關閉,以便更新 UI 或儲存有關已關閉連線的資料。假設您有一個名為 exampleSocket 的變數,它引用了一個開啟的 WebSocket,此處理程式將處理套接字已關閉的情況。

js
exampleSocket.addEventListener("close", (event) => {
  console.log("The connection has been closed successfully.");
});

您可以使用事件處理程式屬性執行相同的操作,如下所示:

js
exampleSocket.onclose = (event) => {
  console.log("The connection has been closed successfully.");
};

規範

規範
WebSocket
# dom-websocket-onclose

瀏覽器相容性

另見