Class Command

A command.

Hierarchy

Command

Implements

ICommand

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Command(params?: Partial<ICommand>): Command

- Defined in Classes/Command.ts:60
Creates a new instance of a command.

Parameters
- params: Partial<ICommand> = {}
  
  The command params.
Returns 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

Implementation of ICommand.addOption
- Defined in Classes/Command.ts:68
Adds a new option to this command.

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

addSubcommand

addSubcommand(subcommand: ICommand): void

Implementation of ICommand.addSubcommand
- Defined in Classes/Command.ts:76
Adds a new subcommand to this command.

Parameters
- subcommand: ICommand
  
  Subcommand instance.
Returns void

clone

clone(): Command

Implementation of ICommand.clone
- Defined in Classes/Command.ts:162
Creates a deep copy of the ICloneable object.

Returns Command

equals

equals(other: Command): boolean

Implementation of ICommand.equals
- Defined in Classes/Command.ts:184
Returns if two IComparable objects are equal.

Parameters
- other: Command
Returns boolean

execute

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

Implementation of ICommand.execute
- Defined in Classes/Command.ts:51
The command execute function.

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

getOption

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

Implementation of ICommand.getOption
- Defined in Classes/Command.ts:123
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>

Implementation of ICommand.getOptionByName
- Defined in Classes/Command.ts:108
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>[]

Implementation of ICommand.getOptionsOfType
- Defined in Classes/Command.ts:99
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"]>

Implementation of ICommand.getValue
- Defined in Classes/Command.ts:138
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"]>

Implementation of ICommand.getValueOrDefault
- Defined in Classes/Command.ts:149
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

Implementation of ICommand.hasOptionOfType
- Defined in Classes/Command.ts:84
Returns if array of options has any option of specific type.

Parameters
- type: OptionType
  
  Target option type.
Returns boolean

toString

toString(): string

Implementation of ICommand.toString
- Defined in Classes/Command.ts:158
A string representation of the argument.

Returns string