WebSocket: WebSocket() コンストラクター

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.

WebSocket() コンストラクターは、新しい WebSocket オブジェクトを返します。

構文

js
new WebSocket(url)
new WebSocket(url, protocols)

引数

url

接続先の URL です。この URL は WebSocket サーバーが応答するものでなければなりません。

protocols 省略可

単一のプロトコル文字列、またはプロトコル文字列の配列のいずれか。これらの文字列はサブプロトコルを示すために使用され、単一のサーバーで複数の WebSocket サブプロトコルを実装することもできます（たとえば、単一のサーバーで指定した protocol に応じて異なる種類のやりとりを処理できるようにしたい場合があります）。

省略された場合は、空配列、すなわち [] が既定で使用されます。

例外

SyntaxError DOMException

次のような場合に発生します。

  • url の解釈に失敗した場合
  • url のスキームが ws または wss 以外であった場合
  • url にフラグメントがあった場合
  • protocols の何れかの値が複数回現れている、または WebSocket プロトコル仕様で定義された Sec-WebSocket-Protocol フィールドの値を構成する要素の要件に一致しない場合。

仕様書

Specification
WebSockets Standard
# ref-for-dom-websocket-websocket①

ブラウザーの互換性

BCD tables only load in the browser

関連情報

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