Class WebSocketClient

Hierarchy

WebSocketClient

Index

Constructors

Properties

client connected heartbeat? ping? ready ws?

Methods

connect disconnect send

Constructors

constructor

new WebSocketClient(client: Client): WebSocketClient
Parameters
- client: Client
Returns WebSocketClient
- Defined in core/src/websocket.ts:19

Properties

client

client: Client

connected

connected: boolean = false

`Private` `Optional` heartbeat

heartbeat?: Timer

`Optional` ping

ping?: number

ready

ready: boolean = false

`Optional` ws

ws?: WebSocket

Methods

connect

connect(disallowReconnect?: boolean): Promise<void>
Connect to the server.
Parameters
- Optional disallowReconnect: boolean
Returns Promise<void>
- Defined in core/src/websocket.ts:37

disconnect

disconnect(): void
Disconnect the WebSocket and disable heartbeats.

Returns void
- Defined in core/src/websocket.ts:22

send

send(notification: ServerboundNotification): void
Send a notification to the server.
Parameters
- notification: ServerboundNotification
Returns void
- Defined in core/src/websocket.ts:29