Class WebSocketConnection

Provides a wrapper for the ws module

Hierarchy

WebSocketConnection

Index

Constructors

Properties

Methods

handleClose handleError handleOpen isReady onMessage

Constructors

constructor

new WebSocketConnection(ws: WebSocket): WebSocketConnection
Parameters
- ws: WebSocket
Returns WebSocketConnection
- Defined in Instance/IO/Wss/Connection.ts:18

Properties

`Private` ws

ws: WebSocket

Methods

`Private` handleClose

handleClose(code: number): void
Method that handles close events
Parameters
- code: number
  
  The WebSocket close code
Returns void
- Defined in Instance/IO/Wss/Connection.ts:64

`Private` handleError

handleError(error: Error): void
Method that handles error events
Parameters
- error: Error
  
  The error that occurred
Returns void
- Defined in Instance/IO/Wss/Connection.ts:52

`Private` handleOpen

handleOpen(): void
Method that handles Open events

Returns void
- Defined in Instance/IO/Wss/Connection.ts:57

isReady

isReady(): Promise<boolean>
Returns Promise<boolean>
- Defined in Instance/IO/Wss/Connection.ts:65

`Private` onMessage

onMessage(message: string): void
Method that handles incoming messages
Parameters
- message: string
  
  The incoming message, either a string or a Buffer
Returns void
- Defined in Instance/IO/Wss/Connection.ts:41
onMessage(message: Buffer): void
Parameters
- message: Buffer
Returns void
- Defined in Instance/IO/Wss/Connection.ts:42

Generated using TypeDoc