EditorSocket
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
TypedEventEmitter<EditorSocketEvents>
Constructors
Constructor
new EditorSocket(connectionManager: SocketConnectionManager, socketName: string): EditorSocket;
Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:14
Parameters
| Parameter | Type | Default value |
|---|---|---|
connectionManager | SocketConnectionManager | undefined |
socketName | string | 'monaco' |
Returns
EditorSocket
Overrides
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
createFile()
createFile(path: string, content?: string): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:90
Parameters
| Parameter | Type |
|---|---|
path | string |
content? | string |
Returns
void
createFolder()
createFolder(path: string): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:98
Parameters
| Parameter | Type |
|---|---|
path | string |
Returns
void
deleteFile()
deleteFile(path: string): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:83
Parameters
| Parameter | Type |
|---|---|
path | string |
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
| Parameter | Type |
|---|---|
event | K |
...args | Parameters<EditorSocketEvents[K]> |
Returns
boolean
Inherited from
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
moveItem()
moveItem(oldPath: string, newPath: string): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:105
Parameters
| Parameter | Type |
|---|---|
oldPath | string |
newPath | string |
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
| Parameter | Type |
|---|---|
event | K |
listener | EditorSocketEvents[K] |
Returns
this
Inherited from
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
| Parameter | Type |
|---|---|
event | K |
listener | EditorSocketEvents[K] |
Returns
this
Inherited from
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
| Parameter | Type |
|---|---|
event | K |
listener | EditorSocketEvents[K] |
Returns
this
Inherited from
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
| Parameter | Type |
|---|---|
path | string |
Returns
void
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
unwatchFolder()
unwatchFolder(path: string): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:120
Parameters
| Parameter | Type |
|---|---|
path | string |
Returns
void
watchFolder()
watchFolder(path: string): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:113
Parameters
| Parameter | Type |
|---|---|
path | string |
Returns
void
writeFile()
writeFile(path: string, content: string): void;
Defined in: CodeBolt/packages/clientsdk/src/sockets/editor.socket.ts:75
Parameters
| Parameter | Type |
|---|---|
path | string |
content | string |
Returns
void