CapabilitySocket

@codebolt/plugin-sdk

---

Class: CapabilitySocket

Defined in: CodeBolt/packages/pluginSdk/src/sockets/capability.socket.ts:9

Capability WebSocket - Query and monitor capabilities, executors, and executions. Action-based protocol with broadcast events.

Extends

• TypedEventEmitter<CapabilitySocketEvents>

Constructors

Constructor

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

Defined in: CodeBolt/packages/pluginSdk/src/sockets/capability.socket.ts:12

Parameters

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

Returns

CapabilitySocket

Overrides

TypedEventEmitter.constructor

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<CapabilitySocketEvents[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<CapabilitySocketEvents[K]>

Returns

boolean

Inherited from

TypedEventEmitter.emit

---

getActiveExecutions()

getActiveExecutions(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/capability.socket.ts:118

Returns

void

---

getCapabilities()

getCapabilities(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/capability.socket.ts:106

Returns

void

---

getCapabilityTypes()

getCapabilityTypes(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/capability.socket.ts:112

Returns

void

---

getExecutors()

getExecutors(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/capability.socket.ts:109

Returns

void

---

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

Returns

this

Inherited from

TypedEventEmitter.off

---

on()

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

Returns

this

Inherited from

TypedEventEmitter.on

---

once()

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

Returns

this

Inherited from

TypedEventEmitter.once

---

refresh()

refresh(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/capability.socket.ts:115

Returns

void

---

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