Class WebSocket

Used to manage WebSocket connections.

Source

export class WebSocket {
    private constructor();
    connect(uri: string, headers?: HttpHeader[]): Promise<WebSocketClient>;
}

Index

Constructors

Methods

Constructors

`Private`constructor

new WebSocket(): WebSocket
Returns WebSocket

Methods

connect

connect(uri: string, headers?: HttpHeader[]): Promise<WebSocketClient>
Parameters
- uri: string
  URL to make connection to.
- Optionalheaders: HttpHeader[]
Returns Promise<WebSocketClient>
An awaitable promise that contains the WebSocket client that was connected.

Remarks
Attempts to connect a WebSocket client.

This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.