Class MonitorCommand<T_CommandOptions>`Internal`

Class to group common behavior among monitor commands.

Type Parameters

T_CommandOptions extends {
[index: string]: any;
}

Hierarchy

Command<T_CommandOptions>
- MonitorCommand

Index

Constructors

Properties

_cmd _cmdToExec emitter globalOptions ipCmd options schema schemaId spawnedProcess

Accessors

Methods

buildCmd close exec on parseLineOutput

Constructors

constructor

new MonitorCommand<T_CommandOptions extends {
[index: string]: any;
}>(schemaId: SchemaIds, schema: JSONSchemaType<T_CommandOptions>, options: T_CommandOptions, globalOptions: GlobalOptions, ipCmd: string[]): MonitorCommand<T_CommandOptions>
Type Parameters
- T_CommandOptions extends {
  [index: string]: any;
  }
Parameters
- schemaId: SchemaIds
- schema: JSONSchemaType<T_CommandOptions>
- options: T_CommandOptions
- globalOptions: GlobalOptions
- ipCmd: string[]
Returns MonitorCommand<T_CommandOptions>
Overrides Command.constructor
- Defined in src/common/classes/monitor-command.ts:60

Properties

`Protected` _cmd

_cmd: (string | number)[] = []

`Protected` _cmdToExec

_cmdToExec: string = ''

`Private` emitter

emitter: EventEmitter = ...

`Protected` globalOptions

globalOptions: GlobalOptions

`Protected` ipCmd

ipCmd: string[]

`Protected` options

options: T_CommandOptions

`Protected` schema

schema: JSONSchemaType<T_CommandOptions>

`Protected` schemaId

schemaId: SchemaIds

`Private` spawnedProcess

spawnedProcess: undefined | ChildProcessWithoutNullStreams

Accessors

cmd

get cmd(): (string | number)[]
Returns (string | number)[]
Inherited from Command.cmd
- Defined in src/common/classes/command.ts:24

cmdToExec

get cmdToExec(): string
Returns string
Inherited from Command.cmdToExec
- Defined in src/common/classes/command.ts:29

Methods

`Protected` buildCmd

buildCmd(): void
Returns void
Inherited from Command.buildCmd
- Defined in src/common/classes/command.ts:45

close

close(): void
Closes the monitor.

Returns void
- Defined in src/common/classes/monitor-command.ts:121

exec

exec(): Promise<MonitorCommand<T_CommandOptions>>
Returns Promise<MonitorCommand<T_CommandOptions>>
Overrides Command.exec
- Defined in src/common/classes/monitor-command.ts:78

on

on(event: "error" | MonitorObjects, cb: ((data?: any) => void)): MonitorCommand<T_CommandOptions>
Listens to the events triggered by the monitor.
Parameters
- event: "error" | MonitorObjects
- cb: ((data?: any) => void)
  - - (data?: any): void
    - Parameters
      
      Optional data: any
      Optional
      
      Returns void
Returns MonitorCommand<T_CommandOptions>
- Defined in src/common/classes/monitor-command.ts:115

`Static` parseLineOutput

parseLineOutput(eventLine: string): MonitorEmittedData
Parameters
- eventLine: string
Returns MonitorEmittedData
- Defined in src/common/classes/monitor-command.ts:21

Generated using TypeDoc