SocketIOClient
Class: SocketIOClient
Defined in: CodeBolt/packages/clientsdk/src/core/socketio-client.ts:13
Constructors
Constructor
new SocketIOClient(url: string, options: SocketIOClientOptions): SocketIOClient;
Defined in: CodeBolt/packages/clientsdk/src/core/socketio-client.ts:18
Parameters
| Parameter | Type |
|---|---|
url | string |
options | SocketIOClientOptions |
Returns
SocketIOClient
Accessors
isConnected
Get Signature
get isConnected(): boolean;
Defined in: CodeBolt/packages/clientsdk/src/core/socketio-client.ts:23
Returns
boolean
Methods
connect()
connect(): Promise<void>;
Defined in: CodeBolt/packages/clientsdk/src/core/socketio-client.ts:27
Returns
Promise<void>
disconnect()
disconnect(): void;
Defined in: CodeBolt/packages/clientsdk/src/core/socketio-client.ts:51
Returns
void
emit()
emit(event: string, ...args: unknown[]): void;
Defined in: CodeBolt/packages/clientsdk/src/core/socketio-client.ts:58
Parameters
| Parameter | Type |
|---|---|
event | string |
...args | unknown[] |
Returns
void
joinRoom()
joinRoom(room: string): void;
Defined in: CodeBolt/packages/clientsdk/src/core/socketio-client.ts:86
Parameters
| Parameter | Type |
|---|---|
room | string |
Returns
void
leaveRoom()
leaveRoom(room: string): void;
Defined in: CodeBolt/packages/clientsdk/src/core/socketio-client.ts:90
Parameters
| Parameter | Type |
|---|---|
room | string |
Returns
void
off()
off(event: string, handler?: (...args: unknown[]) => void): void;
Defined in: CodeBolt/packages/clientsdk/src/core/socketio-client.ts:70
Parameters
| Parameter | Type |
|---|---|
event | string |
handler? | (...args: unknown[]) => void |
Returns
void
on()
on(event: string, handler: (...args: unknown[]) => void): void;
Defined in: CodeBolt/packages/clientsdk/src/core/socketio-client.ts:64
Parameters
| Parameter | Type |
|---|---|
event | string |
handler | (...args: unknown[]) => void |
Returns
void
once()
once(event: string, handler: (...args: unknown[]) => void): void;
Defined in: CodeBolt/packages/clientsdk/src/core/socketio-client.ts:80
Parameters
| Parameter | Type |
|---|---|
event | string |
handler | (...args: unknown[]) => void |
Returns
void