大网数据广告活动
Web 标准与前端开发

WebSocketStream: WebSocketStream() constructor

· 52CE 我爱测

The **`WebSocketStream()`** constructor creates a new WebSocketStream object instance.

WebSockets API

The WebSocketStream() constructor creates a new WebSocketStream object instance.

Syntax

new WebSocketStream(url)
new WebSocketStream(url, options)

Parameters

  • url
    • : A string representing the URL of the WebSocket server you want to connect to with this WebSocketStream instance. Allowed URL schemes are "ws", "wss", "http", and "https".
  • options
    • : An object that can contain the following properties:
      • protocols
        • : A single string or an array of strings representing the sub-protocol(s) that the client would like to use, for example "amqp" or "mqtt". Subprotocols may be selected from the IANA WebSocket Subprotocol Name Registry or may be custom names jointly understood by the client and the server. A single server can implement multiple WebSocket sub-protocols, and handle different types of interactions depending on the specified value. If it is omitted, an empty array is used by default. If protocols is included, the connection will only be established if the server reports that it has selected one of these sub-protocols.
      • signal
        • : An AbortSignal, which can be used to abort the connection before the handshake has completed (that is, before the WebSocketStream.opened promise resolves). This is primarily intended to help implement connection timeouts. As such, it does nothing after the connection is established.

Exceptions

  • SyntaxError DOMException
    • : Thrown if the URL scheme is not one of "ws", "wss", "http", or "https".

Examples

Creating a WebSocketStream

The most basic example takes the URL of a WebSocket server as an argument:

const wss = new WebSocketStream("wss://example.com/wss");

Creating a WebSocketStream with a connection timeout

The following example uses the signal option to implement a timeout if the connection is not established within 5 seconds:

const queueWSS = new WebSocketStream("wss://example.com/queue", {
  signal: AbortSignal.timeout(5000),
});

Note that if you're connecting to localhost, it's likely to succeed or fail before the connection attempt times out.

Once the connection is established, signal has no effect: to close a connection that's already established, call the WebSocketStream.close() method. Closing the underlying WritableStream or WritableStreamDefaultWriter also closes the socket.

See Using WebSocketStream to write a client for a complete example with full explanation.

Specifications

Not currently a part of any specification. See https://github.com/whatwg/websockets/pull/48 for standardization progress.

WebSocketStream API design.

Browser compatibility

See also

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。