Class Command<T_CommandOptions>`Internal`

Class to group common behavior among commands.

Type Parameters

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

Hierarchy

Command
- MonitorCommand

Index

Constructors

Properties

_cmd _cmdToExec globalOptions ipCmd options schema schemaId

Accessors

Methods

buildCmd exec getCmdFromOptions

Constructors

constructor

new Command<T_CommandOptions extends {
[index: string]: any;
}>(schemaId: SchemaIds, schema: JSONSchemaType<T_CommandOptions>, options: T_CommandOptions, globalOptions: GlobalOptions, ipCmd: string[]): Command<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 Command<T_CommandOptions>
- Defined in src/common/classes/command.ts:33

Properties

`Protected` _cmd

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

`Protected` _cmdToExec

_cmdToExec: string = ''

`Protected` globalOptions

globalOptions: GlobalOptions

`Protected` ipCmd

ipCmd: string[]

`Protected` options

options: T_CommandOptions

`Protected` schema

schema: JSONSchemaType<T_CommandOptions>

`Protected` schemaId

schemaId: SchemaIds

Accessors

cmd

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

cmdToExec

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

Methods

`Protected` buildCmd

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

exec

exec<T_ReturnData>(): Promise<Command<T_CommandOptions> | T_ReturnData>
Type Parameters
- T_ReturnData = {}
Returns Promise<Command<T_CommandOptions> | T_ReturnData>
- Defined in src/common/classes/command.ts:142

`Private` getCmdFromOptions

getCmdFromOptions(value: any, key?: string, orderKeysBySchema?: boolean, schema?: JSONSchemaType<any>): (string | number)[]
Parameters
- value: any
- key: string = ''
- orderKeysBySchema: boolean = true
- Optional schema: JSONSchemaType<any>
  Optional
Returns (string | number)[]
- Defined in src/common/classes/command.ts:73

Generated using TypeDoc