WebSocket - Web API | MDN

Toggle sidebar

Theme

OS default
Light
Dark

日本語

Remember language Learn more

WebSocket

Baseline Widely available *

This feature is well established and works across many devices and browser versions. It’s been available across browsers since 2015年7月.

* Some parts of this feature may have varying levels of support.

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

WebSocket オブジェクトは、サーバーへの WebSocket 接続の作成と管理、および接続上のデータの送受信に使用する API を提供します。

WebSocket を構築するには、 WebSocket() コンストラクターを使用してください。

メモ: WebSocket API には背圧を適用する方法がないため、メッセージがアプリケーションの処理速度よりも速く到着すると、アプリケーションはメッセージをバッファリングすることで端末のメモリーを一杯にしたり、 CPU 使用率が 100% になって応答不能になったり、あるいはその両方になったりします。自動的に背圧を提供する代替案については、 WebSocketStream を参照してください。

EventTarget WebSocket

コンストラクター

WebSocket()

新しく作成された WebSocket オブジェクトを返します。

インスタンスプロパティ

WebSocket.binaryType

接続で使用されるバイナリデータ型。

WebSocket.bufferedAmount 読取専用

キューに入れられたデータのバイト数。

WebSocket.extensions 読取専用

サーバーによって選択された拡張機能。

WebSocket.protocol 読取専用

サーバーによって選択されたサブプロトコル。

WebSocket.readyState 読取専用

接続の現在の状態。

WebSocket.url 読取専用

WebSocket の絶対 URL。

インスタンスメソッド

WebSocket.close()

接続を閉じます。

WebSocket.send()

送信するデータをキューに入れます。

イベント

これらのイベントを待ち受けするには、 addEventListener() を使用するか、イベントリスナーをこのインターフェイスの onイベント名プロパティへ代入するかします。

WebSocket による接続が閉じられたときに発生します。 onclose プロパティからも利用できます。

error

WebSocket による接続が、データの一部が送信できなかったなどのエラーのために閉じた時に発生します。 onerror プロパティからも利用できます。

message

WebSocket を通じてデータを受信したときに発生します。 onmessage プロパティからも利用できます。

open

WebSocket による接続が開いたときに発生します。 onopen プロパティからも利用できます。

例

js
// WebSocket 接続を作成
const socket = new WebSocket("ws://localhost:8080");

// 接続が開いたときのイベント
socket.addEventListener("open", (event) => {
  socket.send("Hello Server!");
});

// メッセージの待ち受け
socket.addEventListener("message", (event) => {
  console.log("Message from server ", event.data);
});

仕様書

Specification

WebSockets
# the-websocket-interface

ブラウザーの互換性

Enable JavaScript to view this browser compatibility table.

Help improve MDN

Was this page helpful to you?

Yes No

Learn how to contribute

This page was last modified on 2025年7月22日 by MDN contributors.

View this page on GitHub • Report a problem with this content

WebSocket API (WebSockets)
WebSocket
コンストラクター
1. WebSocket()
インスタンスプロパティ
インスタンスメソッド
1. close()
2. send()
イベント
継承
1. EventTarget
WebSockets API に関連するページ
ガイド
1. WebSocket クライアントアプリケーションを書く
2. WebSocket サーバーを書く
3. C# で WebSocket サーバーを書く
4. Java で WebSocket サーバーを書く
5. WebSocket サーバーを JavaScript (Deno) で書く
6. WebSocketStream でクライアントを書く