Class DefaultSocket

Hierarchy

DefaultSocket

Implements

Socket

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DefaultSocket(url: string, options: SocketOptions): DefaultSocket

- Defined in src/client/socket.ts:239
Parameters
- url: string
- options: SocketOptions
Returns DefaultSocket

Properties

Optional disconnectInitiator

disconnectInitiator: "client" | "server"

isConnected

isConnected: boolean = false

Optional socket

socket: WebSocket

Methods

connect

connect(listener: SocketMessageListener, options?: SocketConnectOptions): Promise<void>

Implementation of Socket.connect
- Defined in src/client/socket.ts:253
Parameters
- listener: SocketMessageListener
- Default value options: SocketConnectOptions = {}
Returns Promise<void>

disconnect

disconnect(): Promise<void>

Implementation of Socket.disconnect
- Defined in src/client/socket.ts:295
Returns Promise<void>

send

send<T>(message: T): Promise<void>

Implementation of Socket.send
- Defined in src/client/socket.ts:332
Type parameters
- T = unknown
Parameters
- message: T
Returns Promise<void>

setApiToken

setApiToken(apiToken: string): void

Implementation of Socket.setApiToken
- Defined in src/client/socket.ts:248
Parameters
- apiToken: string
Returns void

Generated using TypeDoc