CodeboltSocket

@codebolt/client-sdk

---

Class: CodeboltSocket

Defined in: CodeBolt/packages/clientsdk/src/sockets/codebolt.socket.ts:9

Codebolt Agent WebSocket - Agent connection for CLI message processing. Connects with agentId, parentId, threadToken, instanceId params.

Extends

• TypedEventEmitter<CodeboltSocketEvents>

Constructors

Constructor

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

Defined in: CodeBolt/packages/clientsdk/src/sockets/codebolt.socket.ts:12

Parameters

Parameter	Type	Default value
connectionManager	SocketConnectionManager	undefined
socketName	string	'codebolt'

Returns

CodeboltSocket

Overrides

TypedEventEmitter.constructor

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

connect()

connect(params: {
  agentId: string;
  instanceId?: string;
  parentId?: string;
  threadToken?: string;
}): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/codebolt.socket.ts:21

Parameters

Parameter	Type
params	{ agentId: string; instanceId?: string; parentId?: string; threadToken?: string; }
params.agentId	string
params.instanceId?	string
params.parentId?	string
params.threadToken?	string

Returns

void

---

emit()

emit<K>(event: K, ...args: Parameters<CodeboltSocketEvents[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<CodeboltSocketEvents[K]>

Returns

boolean

Inherited from

TypedEventEmitter.emit

---

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: CodeboltSocketEvents[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	CodeboltSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.off

---

on()

on<K>(event: K, listener: CodeboltSocketEvents[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	CodeboltSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.on

---

once()

once<K>(event: K, listener: CodeboltSocketEvents[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	CodeboltSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.once

---

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

---

sendMessage()

sendMessage(message: unknown): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/codebolt.socket.ts:63

Send a CLI message to the agent

Parameters

Parameter	Type
message	unknown

Returns

void