1.5 KiB
1.5 KiB
Class: WebSocket
⚠️ Warning: the WebSocket API is experimental.
Extends: EventTarget
The WebSocket object provides a way to manage a WebSocket connection to a server, allowing bidirectional communication. The API follows the WebSocket spec and RFC 6455.
new WebSocket(url[, protocol])
Arguments:
- url
URL | string- The url's protocol must bewsorwss. - protocol
string | string[] | WebSocketInit(optional) - Subprotocol(s) to request the server use, or aDispatcher.
Example:
This example will not work in browsers or other platforms that don't allow passing an object.
import { WebSocket, ProxyAgent } from 'undici'
const proxyAgent = new ProxyAgent('my.proxy.server')
const ws = new WebSocket('wss://echo.websocket.events', {
dispatcher: proxyAgent,
protocols: ['echo', 'chat']
})
If you do not need a custom Dispatcher, it's recommended to use the following pattern:
import { WebSocket } from 'undici'
const ws = new WebSocket('wss://echo.websocket.events', ['echo', 'chat'])