Skip to main content

EnvironmentDebugSocket

@codebolt/client-sdk


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​

Constructors​

Constructor​

new EnvironmentDebugSocket(connectionManager: SocketConnectionManager, socketName: string): EnvironmentDebugSocket;

Defined in: CodeBolt/packages/clientsdk/src/sockets/environment-debug.socket.ts:13

Parameters​

ParameterTypeDefault value
connectionManagerSocketConnectionManagerundefined
socketNamestring'environmentDebug'

Returns​

EnvironmentDebugSocket

Overrides​

TypedEventEmitter.constructor

Properties​

PropertyModifierTypeInherited fromDefined in
listenersprotectedMap<string | symbol, Set<(...args: any[]) => void>>TypedEventEmitter.listenersCodeBolt/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​

ParameterType
eventK
...argsParameters<EnvironmentDebugSocketEvents[K]>

Returns​

boolean

Inherited from​

TypedEventEmitter.emit


get()​

get(sessionId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/environment-debug.socket.ts:104

Parameters​

ParameterType
sessionIdstring

Returns​

void


getLogs()​

getLogs(sessionId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/environment-debug.socket.ts:107

Parameters​

ParameterType
sessionIdstring

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​

ParameterType
eventstring

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​

ParameterType
eventK
listenerEnvironmentDebugSocketEvents[K]

Returns​

this

Inherited from​

TypedEventEmitter.off


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​

ParameterType
eventK
listenerEnvironmentDebugSocketEvents[K]

Returns​

this

Inherited from​

TypedEventEmitter.on


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​

ParameterType
eventK
listenerEnvironmentDebugSocketEvents[K]

Returns​

this

Inherited from​

TypedEventEmitter.once


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​

ParameterType
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​

ParameterType
sessionIdstring

Returns​

void


unsubscribe()​

unsubscribe(sessionId: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/environment-debug.socket.ts:113

Parameters​

ParameterType
sessionIdstring

Returns​

void