WebSocketStream: closed プロパティ

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

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

closed は WebSocketStream インターフェースの読み取り専用プロパティで、ソケット接続が閉じられた際にオブジェクトで解決するプロミス (Promise) を返します。このオブジェクトには、接続を閉じたコードと理由が含まれています。

値

次のプロパティを含むオブジェクトで履行されるプロミスです。

closeCode: 閉じたコードを表す数値（CloseEvent ステータスコードの完全な一覧を参照）。
reason: ソケット接続が閉じられた理由を、人間が読み取り可能な形で表す文字列。

WebSocket 接続が正常に閉じられなかった場合、プロミスは拒否されます（正常な終了のためには、関連付けられた TCP 接続は WebSocket の終了ハンドシェイクが完了した後に閉じられる必要があります）。

例

const wsURL = "wss://127.0.0.1/";
const wss = new WebSocketStream(wsURL);

wss.closed.then((result) => {
  writeToScreen(
    `DISCONNECTED: code ${result.closeCode}, message "${result.reason}"`,
  );
  console.log("Socket closed", result.closeCode, result.reason);
});

全ての説明付きの完全な例については、 WebSocketStream でクライアントを書くを参照してください。