Skip to main content

EditorSocket

@codebolt/client-sdk


Class: EditorSocket

Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:11

Editor (Monaco) WebSocket - File operations and folder watching. Supports readFolder, writeFile, deleteFile, createFile, createFolder, moveItem, watchFolder, unwatchFolder.

Extends

Constructors

Constructor

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

Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:14

Parameters

ParameterTypeDefault value
connectionManagerSocketConnectionManagerundefined
socketNamestring'monaco'

Returns

EditorSocket

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

createFile()

createFile(path: string, content?: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:90

Parameters

ParameterType
pathstring
content?string

Returns

void


createFolder()

createFolder(path: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:98

Parameters

ParameterType
pathstring

Returns

void


deleteFile()

deleteFile(path: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:83

Parameters

ParameterType
pathstring

Returns

void


emit()

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

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

Type Parameters

Type Parameter
K extends string

Parameters

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

Returns

boolean

Inherited from

TypedEventEmitter.emit


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


moveItem()

moveItem(oldPath: string, newPath: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:105

Parameters

ParameterType
oldPathstring
newPathstring

Returns

void


off()

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

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

Type Parameters

Type Parameter
K extends string

Parameters

ParameterType
eventK
listenerEditorSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.off


on()

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

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

Type Parameters

Type Parameter
K extends string

Parameters

ParameterType
eventK
listenerEditorSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.on


once()

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

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

Type Parameters

Type Parameter
K extends string

Parameters

ParameterType
eventK
listenerEditorSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.once


ping()

ping(): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:127

Returns

void


readFolder()

readFolder(path: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:68

Parameters

ParameterType
pathstring

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


unwatchFolder()

unwatchFolder(path: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:120

Parameters

ParameterType
pathstring

Returns

void


watchFolder()

watchFolder(path: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:113

Parameters

ParameterType
pathstring

Returns

void


writeFile()

writeFile(path: string, content: string): void;

Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:75

Parameters

ParameterType
pathstring
contentstring

Returns

void