ChatCommand | commandbot

A representation of CHAT_INPUT command (also known as a slash command)

Hierarchy

PermissionGuildCommand
- ChatCommand
  - HelpMessage

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ChatCommand(manager: CommandManager, options: ChatCommandInit): ChatCommand

Overrides PermissionGuildCommand.constructor
- Defined in src/commands/ChatCommand.ts:114
ChatCommand constructor

Parameters
- manager: CommandManager
  
  a manager that this command belongs to
- options: ChatCommandInit
  
  ChatCommandInit object containing all options needed to create a ChatCommand
Returns ChatCommand

Properties

Private Readonly _children

_children: ChildCommandResolvable[] = []

Subcommands and groups of this command

readonly

Optional Readonly aliases

aliases?: string[]

List of different names that can be used to invoke a command (when using prefix interactions)

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 description

description: string

Command description displayed in the help message or in slash commands menu (Default description: "No description")

readonly

Readonly dm

dm: boolean

If set to false, all interactions that get invoked from private/direct conversations (outside a guild) will result a PermissionError

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)

Optional Readonly guilds

guilds?: string[]

List of Discord guild (server) IDs in which this command can be used

readonly

Readonly manager

manager: CommandManager

Manager in which this command is registered

readonly

Readonly name

name: string

Command name

readonly

Readonly parameters

parameters: Parameter<any>[]

List of parameters that can passed to this command

readonly

Readonly permissions

permissions: CommandPermissions

Object containing check functions and permission bitfields

readonly

Readonly slash

slash: boolean

Whether this command should be registered as a slash command (default: true)

readonly

Readonly type

type: CommandType

CommandBot's internal command type

readonly

Optional Readonly usage

usage?: string

Command usage displayed in the help message

readonly

Readonly visible

visible: boolean

Whether this command is visible in the help message (default: true)

readonly

Accessors

children

get children(): readonly ChildCommandResolvable[]

- Defined in src/commands/ChatCommand.ts:174
Returns list of attached subcommands

readonly
Returns readonly ChildCommandResolvable[]

hasSubCommands

get hasSubCommands(): boolean

- Defined in src/commands/ChatCommand.ts:166
Returns true if the command has subcommands attached

Returns boolean

Methods

append

append<T>(type: T, options: ChildCommandInit<T>): ChildCommands<T>

- Defined in src/commands/ChatCommand.ts:199
Attaches subcommand or subcommand group to this ChatCommand

remarks
After appending a subcommand or a subcommand group the main command can only be invoked using prefix interactions

Type parameters
- T: ChildCommandType
Parameters
- type: T
  
  subcommand type
- options: ChildCommandInit<T>
  
  initialization options
Returns ChildCommands<T>
A computed subcommand object

fetchSubcommand

fetchSubcommand(options: CommandInteractionOption[], interaction: Message | Interaction): null | InputManager

- Defined in src/commands/ChatCommand.ts:223
Parameters
- options: CommandInteractionOption[]
  
  parameter options
- interaction: Message | Interaction
  
  Discord interaction
Returns null | InputManager
an InputManager containing all interaction-related data or null

getSubcommand

getSubcommand(name: string, group?: string): null | SubCommand

- Defined in src/commands/ChatCommand.ts:281
Parameters
- name: string
  
  subcommand name
- Optional group: string
Returns null | SubCommand
a SubCommand object or null

isBaseCommandType

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

Inherited from PermissionGuildCommand.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 PermissionGuildCommand.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 PermissionGuildCommand.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>

Overrides PermissionGuildCommand.start
- Defined in src/commands/ChatCommand.ts:185
Invoke the command

async
Parameters
- input: InputManager
  
  input data manager
Returns Promise<void>

toObject

toObject(): ChatCommandObject

Overrides PermissionGuildCommand.toObject
- Defined in src/commands/ChatCommand.ts:299
Converts ChatCommand instance to object that is recognized by the Discord API

Returns ChatCommandObject
Discord API object

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

manager: CommandManager

options: ChatCommandInit

Returns ChatCommand

Properties

Private Readonly _children

Optional Readonly aliases

Readonly announceSuccess

Readonly default_permission

Readonly description

Readonly dm

Readonly ephemeral

Optional Readonly guilds

Readonly manager

Readonly name

Readonly parameters

Readonly permissions

Readonly slash

Readonly type

Optional Readonly usage

Readonly visible

Accessors

children

Returns readonly ChildCommandResolvable[]

hasSubCommands

Returns boolean

Methods

append

Type parameters

T: ChildCommandType

Parameters

type: T

options: ChildCommandInit<T>

Returns ChildCommands<T>

fetchSubcommand

Parameters

options: CommandInteractionOption[]

interaction: Message | Interaction

Returns null | InputManager

getSubcommand

Parameters

name: string

Optional group: string

Returns null | SubCommand

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 ChatCommandObject