Class ShellService

Hierarchy (View Summary, Expand)

Service
- ShellService

Index

Constructors

Properties

application client logger server wss name

Methods

boot executeCommand executeShellCommand getName

Constructors

constructor

new ShellService(application: Application): ShellService
Parameters
- application: Application
Returns ShellService
Overrides Service.constructor
- Defined in src/main/typescript/services/ShellService.ts:43

Properties

`Protected` `Readonly`application

application: Application

`Protected` `Readonly`client

client: BaseClient

`Protected` `Readonly`logger

logger: Logger

`Readonly`server

server: Server = ...

`Readonly`wss

wss: Server<typeof WebSocket>

`Protected` `Static`name

name: string

Returns the name of the function. Function names are read-only and can not be changed.

Methods

boot

boot(): Promise<void>
Returns Promise<void>
Overrides Service.boot
- Defined in src/main/typescript/services/ShellService.ts:51

executeCommand

executeCommand(
    commandString: string,
    ws: WebSocket,
    defaultContext?: ShellCommandContext,
): Promise<void>
Parameters
- commandString: string
- ws: WebSocket
- OptionaldefaultContext: ShellCommandContext
Returns Promise<void>
- Defined in src/main/typescript/services/ShellService.ts:271

executeShellCommand

executeShellCommand(command: string, ws: WebSocket): void
Parameters
- command: string
- ws: WebSocket
Returns void
- Defined in src/main/typescript/services/ShellService.ts:130

`Static`getName

getName(): string
Returns string
Inherited from Service.getName
- Defined in src/framework/typescript/services/Service.ts:38