Class WebSocketClient

Hierarchy

WebSocketClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebSocketClient(client: Client): WebSocketClient

- Defined in src/websocket/client.ts:22
Parameters
- client: Client
Returns WebSocketClient

Properties

client

client: Client

connected

connected: boolean

Optional heartbeat

heartbeat: number

Optional ping

ping: number

ready

ready: boolean

Optional ws

ws: WebSocket

Methods

connect

connect(disallowReconnect?: boolean): Promise<void>

- Defined in src/websocket/client.ts:65
Connect the WebSocket

Parameters
- Optional disallowReconnect: boolean
  
  Whether to disallow reconnection
Returns Promise<void>

disconnect

disconnect(): void

- Defined in src/websocket/client.ts:32
Disconnect the WebSocket and disable heartbeats.

Returns void

send

send(notification: ServerboundNotification): void

- Defined in src/websocket/client.ts:49
Send a notification

Parameters
- notification: ServerboundNotification
  
  Serverbound notification
Returns void

Generated using TypeDoc