Skip to main content

LocalModelSocket

@codebolt/plugin-sdk


Class: LocalModelSocket

Defined in: CodeBolt/packages/pluginSdk/src/sockets/local-model.socket.ts:9

Local Model WebSocket - Receive local model download/management broadcast events. Broadcast-only: download started/progress/complete/error, deleted.

Extends​

Constructors​

Constructor​

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

Defined in: CodeBolt/packages/pluginSdk/src/sockets/local-model.socket.ts:12

Parameters​

ParameterTypeDefault value
connectionManagerSocketConnectionManagerundefined
socketNamestring'localModel'

Returns​

LocalModelSocket

Overrides​

TypedEventEmitter.constructor

Properties​

PropertyModifierTypeInherited fromDefined in
listenersprotectedMap<string | symbol, Set<(...args: any[]) => void>>TypedEventEmitter.listenersCodeBolt/packages/pluginSdk/src/core/event-emitter.ts:24

Methods​

emit()​

emit<K>(event: K, ...args: Parameters<LocalModelSocketEvents[K]>): boolean;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:54

Type Parameters​

Type Parameter
K extends string

Parameters​

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

Returns​

boolean

Inherited from​

TypedEventEmitter.emit


listenerCount()​

listenerCount(event: string): number;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:75

Parameters​

ParameterType
eventstring

Returns​

number

Inherited from​

TypedEventEmitter.listenerCount


off()​

off<K>(event: K, listener: LocalModelSocketEvents[K]): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:35

Type Parameters​

Type Parameter
K extends string

Parameters​

ParameterType
eventK
listenerLocalModelSocketEvents[K]

Returns​

this

Inherited from​

TypedEventEmitter.off


on()​

on<K>(event: K, listener: LocalModelSocketEvents[K]): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:27

Type Parameters​

Type Parameter
K extends string

Parameters​

ParameterType
eventK
listenerLocalModelSocketEvents[K]

Returns​

this

Inherited from​

TypedEventEmitter.on


once()​

once<K>(event: K, listener: LocalModelSocketEvents[K]): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:46

Type Parameters​

Type Parameter
K extends string

Parameters​

ParameterType
eventK
listenerLocalModelSocketEvents[K]

Returns​

this

Inherited from​

TypedEventEmitter.once


ping()​

ping(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/local-model.socket.ts:78

Returns​

void


removeAllListeners()​

removeAllListeners(event?: string): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:66

Parameters​

ParameterType
event?string

Returns​

this

Inherited from​

TypedEventEmitter.removeAllListeners