Class Command

Bot core command object

Hierarchy

Command
- SubCommandGroup
- FunctionCommand

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Command(manager: CommandManager, type: CommandType, options: APICommandInit): Command

- Defined in src/commands/base/Command.ts:69
Command core constructor

Parameters
- manager: CommandManager
  
  manager bound to this command
- type: CommandType
  
  command internal type
- options: APICommandInit
  
  initialization options
Returns Command

Properties

Readonly default_permission

default_permission: boolean

Discord API default_permission

readonly

Readonly manager

manager: CommandManager

Manager in which this command is registered

readonly

Readonly name

name: string

Command name

readonly

Readonly type

type: CommandType

CommandBot's internal command type

readonly

Methods

isBaseCommandType

isBaseCommandType<T>(type: T): this is BaseCommands<T>

- Defined in src/commands/base/Command.ts:100
Check base command type

Type parameters
- T: BaseCommandType
Parameters
- type: T
  
  base command type
Returns this is BaseCommands<T>
Whether this command can be used as the given type

isChildCommandType

isChildCommandType<T>(type: T): this is ChildCommands<T>

- Defined in src/commands/base/Command.ts:165
Check child command type

Type parameters
- T: ChildCommandType
Parameters
- type: T
  
  child command type
Returns this is ChildCommands<T>
Whether this command can be used as a child command of the given type

isCommandType

isCommandType<T>(type: T): this is Commands<T>

- Defined in src/commands/base/Command.ts:139
Checks command type

Type parameters
- T: CommandType
Parameters
- type: T
  
  command type
Returns this is Commands<T>
Whether this command can be used as the given type

toObject

toObject(): APICommandObject

- Defined in src/commands/base/Command.ts:88
Converts a command instance to an APICommandObject

Returns APICommandObject
An object that is accepted by the Discord API

Generated using TypeDoc