ShellSocket
Class: ShellSocket
Defined in: CodeBolt/packages/pluginSdk/src/sockets/shell.socket.ts:10
Shell WebSocket - Raw PTY bidirectional communication. Send commands as text, receive output, support resize.
Extends
TypedEventEmitter<ShellSocketEvents>
Constructors
Constructor
new ShellSocket(connectionManager: SocketConnectionManager): ShellSocket;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/shell.socket.ts:14
Parameters
| Parameter | Type |
|---|---|
connectionManager | SocketConnectionManager |
Returns
ShellSocket
Overrides
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<ShellSocketEvents[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<ShellSocketEvents[K]> |
Returns
boolean
Inherited from
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: ShellSocketEvents[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 | ShellSocketEvents[K] |
Returns
this
Inherited from
on()
on<K>(event: K, listener: ShellSocketEvents[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 | ShellSocketEvents[K] |
Returns
this
Inherited from
once()
once<K>(event: K, listener: ShellSocketEvents[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 | ShellSocketEvents[K] |
Returns
this
Inherited from
ping()
ping(): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/shell.socket.ts:59
Send ping
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
resize()
resize(cols: number, rows: number): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/shell.socket.ts:50
Resize the PTY
Parameters
| Parameter | Type |
|---|---|
cols | number |
rows | number |
Returns
void
send()
send(command: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/shell.socket.ts:45
Send a command/text to the PTY
Parameters
| Parameter | Type |
|---|---|
command | string |
Returns
void