FunctionCommand | commandbot

Function (executable) command

Hierarchy

Command
- FunctionCommand
  - GuildCommand
  - PermissionCommand

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FunctionCommand(manager: CommandManager, type: CommandType, options: FunctionCommandInit): FunctionCommand

Overrides Command.constructor
- Defined in src/commands/base/FunctionCommand.ts:79
Executable command constructor

Parameters
- manager: CommandManager
  
  command manager attached to this command
- type: CommandType
  
  command type
- options: FunctionCommandInit
  
  command initailization options
Returns FunctionCommand

Properties

Private Readonly _function

_function: CommandFunction

Command function (called on command execution)

readonly

Readonly announceSuccess

announceSuccess: boolean

Whether a SUCCESS message should be sent after executing the command function (when there is no other reply)

readonly

Readonly default_permission

default_permission: boolean

Discord API default_permission

readonly

Readonly ephemeral

ephemeral: EphemeralType

Whether a reply should be visible only to the caller

NONE - bot replies are public and visible to everyone in a text channel
INTERACTIONS - bot will mark responses to Discord interactions as ephemeral and they will only be visible to the command caller
FULL - INTERACTIONS + responses to prefix interactions will be sent as direct messages to the command caller

readonly
remarks: Since ephemeral interactions cannot be deleted, a placeholding embed will be sent when there will be no response from the command function and announceSuccess will be set to false (placeholding message uses color and title parameters from SUCCESS system message configuration)

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

Private handleReply

handleReply(interaction: Message | Interaction, result: string | void | MessageEmbed | ReplyMessageOptions): Promise<void>

- Defined in src/commands/base/FunctionCommand.ts:115
Reply handler

async
Parameters
- interaction: Message | Interaction
  
  Discord interaction object
- result: string | void | MessageEmbed | ReplyMessageOptions
  
  result of command function execution
Returns Promise<void>

isBaseCommandType

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

Inherited from Command.isBaseCommandType
- 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>

Inherited from Command.isChildCommandType
- 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>

Inherited from Command.isCommandType
- 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

start

start(input: InputManager): Promise<void>

- Defined in src/commands/base/FunctionCommand.ts:102
Invoke the command

async
Parameters
- input: InputManager
  
  input data manager
Returns Promise<void>
A Promise that resolves after the function command is completed

toObject

toObject(): APICommandObject

Inherited from Command.toObject
- 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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

manager: CommandManager

type: CommandType

options: FunctionCommandInit

Returns FunctionCommand

Properties

Private Readonly _function

Readonly announceSuccess

Readonly default_permission

Readonly ephemeral

Readonly manager

Readonly name

Readonly type

Methods

Private handleReply

Parameters

interaction: Message | Interaction

result: string | void | MessageEmbed | ReplyMessageOptions

Returns Promise<void>

isBaseCommandType

Type parameters

T: BaseCommandType

Parameters

type: T

Returns this is BaseCommands<T>

isChildCommandType

Type parameters

T: ChildCommandType

Parameters

type: T

Returns this is ChildCommands<T>

isCommandType

Type parameters

T: CommandType

Parameters

type: T

Returns this is Commands<T>

start

Parameters

input: InputManager

Returns Promise<void>

toObject

Returns APICommandObject