【Node.js24.x】CloseEvent::CloseEvent()関数の使い方

CloseEvent関数は、CloseEventクラスの新しいインスタンスを生成するために使用されるコンストラクタ関数です。CloseEventクラスは、WebSocket接続の終了時やWebRTCデータチャネルのクローズ時など、通信チャネルが閉じられた際に発生するイベントを表します。このイベントは、接続が正常に終了したのか、特定の終了コードを伴って終了したのか、あるいはエラーによって終了したのかといった詳細な情報を提供します。

このCloseEvent関数を呼び出すことで、開発者はCloseEventオブジェクトを作成できます。第一引数にはイベントの種類を示す文字列（通常は"close"）、第二引数にはオプションとしてCloseEventInitオブジェクトを渡します。CloseEventInitオブジェクトには、接続が意図通りにクリーンに終了したかを示すブール値のwasClean、接続終了の原因を示す数値のcode、接続終了の具体的な理由を示す文字列のreasonなどのプロパティを含めることができます。

例えば、WebSocket接続が予期せぬ理由で切断された場合、この関数を使ってwasCleanがfalse、適切なcodeとreasonを持つCloseEventオブジェクトを生成し、アプリケーション内でその状況を処理する際に利用できます。CloseEvent関数は、接続終了イベントをプログラム的に構築し、その詳細な状態を表現するための重要な手段となります。

Copy
1new CloseEvent('close', { code: 1000, reason: 'Normal Closure', wasClean: true });

type, options = {}

• type: string: イベントの種類を指定します。CloseEventでは通常"close"です。
• options: object = {}: イベントに関連する追加オプションを指定するオブジェクトです。
  • code: number = 1000: クローズコードを指定する整数。
  • reason: string = '': クローズの理由を指定する文字列。
  • wasClean: boolean = false: 接続がクリーンにクローズされたかどうかを示すブール値。

CloseEvent

CloseEventのコンストラクタです。新しいCloseEventインスタンスを生成します。