KvStoreSocket

@codebolt/plugin-sdk

---

Class: KvStoreSocket

Defined in: CodeBolt/packages/pluginSdk/src/sockets/kv-store.socket.ts:9

KV Store WebSocket - Receive key-value store broadcast events. Broadcast-only: instance CRUD, record set/deleted, namespace cleared.

Extends

• TypedEventEmitter<KvStoreSocketEvents>

Constructors

Constructor

new KvStoreSocket(connectionManager: SocketConnectionManager): KvStoreSocket;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/kv-store.socket.ts:12

Parameters

Parameter	Type
connectionManager	SocketConnectionManager

Returns

KvStoreSocket

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

Returns

boolean

Inherited from

TypedEventEmitter.emit

---

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

Returns

this

Inherited from

TypedEventEmitter.off

---

on()

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

Returns

this

Inherited from

TypedEventEmitter.on

---

once()

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

Returns

this

Inherited from

TypedEventEmitter.once

---

ping()

ping(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/kv-store.socket.ts:39

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