Class ServerConsoleConnection

Index

Constructors

Methods

connect disconnect getLogs getStats on requestLogs requestStats sendCommand sendPoweraction

Constructors

constructor

new ServerConsoleConnection(server, userClient, prettyLogs): ServerConsoleConnection
Parameters
- server: Server
- userClient: UserClient
- prettyLogs: boolean
Returns ServerConsoleConnection
- Defined in src/UserClient/ServerConsoleConnection.ts:39

Methods

connect

connect(debugLogging?): Promise<void>
Connect to a servers console. You can then listen on the
Parameters
- OptionaldebugLogging: boolean
  Debug enabled?
Returns Promise<void>
- Defined in src/UserClient/ServerConsoleConnection.ts:50

disconnect

disconnect(): void
Disconnect from the server.

Returns void
- Defined in src/UserClient/ServerConsoleConnection.ts:168

getLogs

getLogs(): Promise<string[]>
Get the logs of this server

Returns Promise<string[]>
- Defined in src/UserClient/ServerConsoleConnection.ts:214

getStats

getStats(): Promise<StatsWsJson>
Get the stats of this server

Returns Promise<StatsWsJson>
- Defined in src/UserClient/ServerConsoleConnection.ts:192

on

on(eventName, listener): void
Parameters
- eventName: SocketEvent
- listener: ((arg?: string | BackupCompletedJson | StatsWsJson) => void)
  - - (arg?): void
    - Parameters
      Optionalarg: string | BackupCompletedJson | StatsWsJson
      Returns void
Returns void
- Defined in src/UserClient/ServerConsoleConnection.ts:31

requestLogs

requestLogs(): void
Request the logs of this server

Returns void
- Defined in src/UserClient/ServerConsoleConnection.ts:185

requestStats

requestStats(): void
Request the stats of this server

Returns void
- Defined in src/UserClient/ServerConsoleConnection.ts:178

sendCommand

sendCommand(cmd): void
Send a command to this server
Parameters
- cmd: string
Returns void
- Defined in src/UserClient/ServerConsoleConnection.ts:251

sendPoweraction

sendPoweraction(action): void
Send a power action to this server
Parameters
- action: ServerSignalOption
Returns void
- Defined in src/UserClient/ServerConsoleConnection.ts:244