MainSocket
Class: MainSocket
Defined in: CodeBolt/packages/pluginSdk/src/sockets/main.socket.ts:9
Main WebSocket - Primary connection to the server. Minimal handler, mainly for connection status.
Extends
TypedEventEmitter<MainSocketEvents>
Constructors
Constructor
new MainSocket(connectionManager: SocketConnectionManager, socketName: string): MainSocket;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/main.socket.ts:12
Parameters
| Parameter | Type | Default value |
|---|---|---|
connectionManager | SocketConnectionManager | undefined |
socketName | string | 'main' |
Returns
MainSocket
Overrides
Properties
| Property | Modifier | Type | Inherited from | Defined in |
|---|---|---|---|---|
listeners | protected | Map<string | symbol, Set<(...args: any[]) => void>> | TypedEventEmitter.listeners | CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:24 |
Methods
emit()
emit<K>(event: K, ...args: Parameters<MainSocketEvents[K]>): boolean;
Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:54
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
...args | Parameters<MainSocketEvents[K]> |
Returns
boolean
Inherited from
listenerCount()
listenerCount(event: string): number;
Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:75
Parameters
| Parameter | Type |
|---|---|
event | string |
Returns
number
Inherited from
TypedEventEmitter.listenerCount
off()
off<K>(event: K, listener: MainSocketEvents[K]): this;
Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:35
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | MainSocketEvents[K] |
Returns
this
Inherited from
on()
on<K>(event: K, listener: MainSocketEvents[K]): this;
Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:27
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | MainSocketEvents[K] |
Returns
this
Inherited from
once()
once<K>(event: K, listener: MainSocketEvents[K]): this;
Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:46
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | MainSocketEvents[K] |
Returns
this
Inherited from
removeAllListeners()
removeAllListeners(event?: string): this;
Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:66
Parameters
| Parameter | Type |
|---|---|
event? | string |
Returns
this
Inherited from
TypedEventEmitter.removeAllListeners
send()
send(message: unknown): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/main.socket.ts:49
Send a message
Parameters
| Parameter | Type |
|---|---|
message | unknown |
Returns
void