EnvironmentDebugSocket
Class: EnvironmentDebugSocket
Defined in: CodeBolt/packages/clientsdk/src/sockets/environment-debug.socket.ts:10
Environment Debug WebSocket - Debug environment sessions with subscribe support. Subscribe-based: list, get, get-logs, subscribe/unsubscribe for session events. Additional events: state-changed, health-check.
Extends
TypedEventEmitter<EnvironmentDebugSocketEvents>
Constructors
Constructor
new EnvironmentDebugSocket(connectionManager: SocketConnectionManager, socketName: string): EnvironmentDebugSocket;
Defined in: CodeBolt/packages/clientsdk/src/sockets/environment-debug.socket.ts:13
Parameters
| Parameter | Type | Default value |
|---|---|---|
connectionManager | SocketConnectionManager | undefined |
socketName | string | 'environmentDebug' |
Returns
EnvironmentDebugSocket
Overrides
Properties
| Property | Modifier | Type | Inherited from | Defined in |
|---|---|---|---|---|
listeners | protected | Map<string | symbol, Set<(...args: any[]) => void>> | TypedEventEmitter.listeners | CodeBolt/packages/clientsdk/src/core/event-emitter.ts:24 |
Methods
emit()
emit<K>(event: K, ...args: Parameters<EnvironmentDebugSocketEvents[K]>): boolean;
Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:54
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
...args | Parameters<EnvironmentDebugSocketEvents[K]> |
Returns
boolean
Inherited from
get()
get(sessionId: string): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/environment-debug.socket.ts:104
Parameters
| Parameter | Type |
|---|---|
sessionId | string |
Returns
void
getLogs()
getLogs(sessionId: string): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/environment-debug.socket.ts:107
Parameters
| Parameter | Type |
|---|---|
sessionId | string |
Returns
void
list()
list(): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/environment-debug.socket.ts:101
Returns
void
listenerCount()
listenerCount(event: string): number;
Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:75
Parameters
| Parameter | Type |
|---|---|
event | string |
Returns
number
Inherited from
TypedEventEmitter.listenerCount
off()
off<K>(event: K, listener: EnvironmentDebugSocketEvents[K]): this;
Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:35
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | EnvironmentDebugSocketEvents[K] |
Returns
this
Inherited from
on()
on<K>(event: K, listener: EnvironmentDebugSocketEvents[K]): this;
Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:27
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | EnvironmentDebugSocketEvents[K] |
Returns
this
Inherited from
once()
once<K>(event: K, listener: EnvironmentDebugSocketEvents[K]): this;
Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:46
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | EnvironmentDebugSocketEvents[K] |
Returns
this
Inherited from
ping()
ping(): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/environment-debug.socket.ts:116
Returns
void
removeAllListeners()
removeAllListeners(event?: string): this;
Defined in: CodeBolt/packages/clientsdk/src/core/event-emitter.ts:66
Parameters
| Parameter | Type |
|---|---|
event? | string |
Returns
this
Inherited from
TypedEventEmitter.removeAllListeners
subscribe()
subscribe(sessionId: string): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/environment-debug.socket.ts:110
Parameters
| Parameter | Type |
|---|---|
sessionId | string |
Returns
void
unsubscribe()
unsubscribe(sessionId: string): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/environment-debug.socket.ts:113
Parameters
| Parameter | Type |
|---|---|
sessionId | string |
Returns
void