Interface ICommand

A command.

Hierarchy

Implemented by

Command

Properties

aliases

aliases: string[]

The command aliases.

description

description: string

The command description.

examples

examples: string[]

Example usage of this command.

name

name: string

The command name.

options

options: IOption<InputData>[]

The list of command options.

shortDescription

shortDescription: string

Shortened description of this command.

subcommands

subcommands: Map<string, ICommand>

Subcommands of this command.

title

title: string

The command title.

Methods

addOption

addOption(option: IOption<InputData>): void

- Defined in Interfaces/ICommand.ts:53
Adds a new option to this command.

Parameters
- option: IOption<InputData>
  
  Option instance.
Returns void

addSubcommand

addSubcommand(subcommand: ICommand): void

- Defined in Interfaces/ICommand.ts:58
Adds a new subcommand to this command.

Parameters
- subcommand: ICommand
  
  Subcommand instance.
Returns void

clone

clone(): ICommand

Inherited from ICloneable.clone
- Defined in Interfaces/Types/ICloneable.ts:8
Creates a deep copy of the ICloneable object.

Returns ICommand

equals

equals(other: IComparable): boolean

Inherited from IComparable.equals
- Defined in Interfaces/Types/IComparable.ts:9
Returns if two IComparable objects are equal.

Parameters
- other: IComparable
  
  Other IComparable object.
Returns boolean

execute

execute(...args: any[]): any

- Defined in Interfaces/ICommand.ts:103
The command execute function.

Parameters
- Rest ...args: any[]
Returns any

getOption

getOption<T>(Option: (new () => T)): null | T

- Defined in Interfaces/ICommand.ts:84
Searches for an actual option instance by a class.

Type Parameters
- T extends IOption<InputData, T>
Parameters
- Option: (new () => T)
  
  Option class.
  - - new (): T
    - Returns T
Returns null | T
Option instance or null if not found.

getOptionByName

getOptionByName(name: string): null | IOption<InputData>

- Defined in Interfaces/ICommand.ts:77
Searches for an actual option instance by option name.

Parameters
- name: string
  
  Option name.
Returns null | IOption<InputData>
Option instance or null if not found.

getOptionsOfType

getOptionsOfType(type: OptionType): IOption<InputData>[]

- Defined in Interfaces/ICommand.ts:70
Returns all options of specific type.

Parameters
- type: OptionType
  
  Target option type.
Returns IOption<InputData>[]
Filtered option array.

getValue

getValue<T>(Option: (new () => T)): ReturnType<T["getValue"]>

- Defined in Interfaces/ICommand.ts:91
Tries to get current value of the specified option.

Type Parameters
- T extends IOption<InputData, T>
Parameters
- Option: (new () => T)
  
  Option class.
  - - new (): T
    - Returns T
Returns ReturnType<T["getValue"]>
Current value or null.

getValueOrDefault

getValueOrDefault<T>(Option: (new () => T)): ReturnType<T["getValueOrDefault"]>

- Defined in Interfaces/ICommand.ts:98
Gets current or default value of the specified option.

Type Parameters
- T extends IOption<InputData, T>
Parameters
- Option: (new () => T)
  
  Option class.
  - - new (): T
    - Returns T
Returns ReturnType<T["getValueOrDefault"]>
Current or default value of the option.

hasOptionOfType

hasOptionOfType(type: OptionType): boolean

- Defined in Interfaces/ICommand.ts:63
Returns if array of options has any option of specific type.

Parameters
- type: OptionType
  
  Target option type.
Returns boolean

toString

toString(): string

Inherited from IStringable.toString
- Defined in Interfaces/Types/IStringable.ts:8
Returns string
A string representation of this object.