Class SuperCommand<T, TUser, TBot>`Abstract` `Alpha`

Another way to create commands.

Type Parameters

T extends Bot<any>
TUser = T extends Bot<infer U>
? U
: never
TBot extends Bot<TUser> = T

Hierarchy (view full)

Command<TBot>
- SuperCommand

Index

Constructors

Properties

bot caller cmdBuilder log routes

Accessors

description modOnly

Methods

autocomplete create createRoute execute getName globalCommand guildCommand processArgs userlessExecute

Constructors

constructor

new SuperCommand<T, TUser, TBot>(bot): SuperCommand<T, TUser, TBot>
Type Parameters
- T extends Bot<any>
- TUser = T extends Bot<U>
  ? U
  : never
- TBot extends Bot<TUser> = T
Parameters
- bot: TBot
Returns SuperCommand<T, TUser, TBot>
Overrides Command.constructor
- Defined in src/supercommand.ts:79

Properties

`Readonly` bot

bot: TBot

`Protected` caller

caller: TUser

`Private` cmdBuilder

cmdBuilder: SlashCommandBuilder

`Readonly` log

log: Logger<ILogObj> = ...

routes

routes: SuperCommandRoute[] = []

Accessors

`Abstract` description

get description(): string
Returns string
- Defined in src/supercommand.ts:76

`Abstract` modOnly

get modOnly(): boolean
Returns boolean
- Defined in src/supercommand.ts:77

Methods

autocomplete

autocomplete(cmd): Promise<void>
Runs when an autocomplete interaction is called for this function.
Parameters
- cmd: AutocompleteInteraction<CacheType>
  Autocomplete interaction.
Returns Promise<void>
Inherited from Command.autocomplete
- Defined in src/command.ts:65

create

create(): SlashCommandBuilder
Create the SlashCommandBuilder.

Returns SlashCommandBuilder
The command
Overrides Command.create
- Defined in src/supercommand.ts:97

createRoute

createRoute<T>(cmd, route): T
Type Parameters
- T extends SlashCommandSubcommandBuilder | SlashCommandBuilder
Parameters
- cmd: T
- route: SuperCommandRoute
Returns T
- Defined in src/supercommand.ts:84

execute

execute(msg): Promise<void>
Runs when the command is run.
Parameters
- msg: ChatInputCommandInteraction<CacheType>
  Command interaction
Returns Promise<void>
Overrides Command.execute
- Defined in src/supercommand.ts:121

`Abstract` getName

getName(): string
The name of the command.

Returns string
The name
Inherited from Command.getName
- Defined in src/command.ts:20

globalCommand

globalCommand(): boolean
Returns boolean
If this command is a global command
Inherited from Command.globalCommand
- Defined in src/command.ts:32

guildCommand

guildCommand(): boolean
Returns boolean
If this command is a guild command
Inherited from Command.guildCommand
- Defined in src/command.ts:39

`Private` processArgs

processArgs(msg, args): any[]
Parameters
- msg: ChatInputCommandInteraction<CacheType>
- args: SuperCommandArg[]
Returns any[]
- Defined in src/supercommand.ts:131

userlessExecute

userlessExecute(msg): Promise<void>
Runs when the command is run only if the command is run in a DM or in a server without the bot
Parameters
- msg: ChatInputCommandInteraction<CacheType>
  Command interaction
Returns Promise<void>
Inherited from Command.userlessExecute
- Defined in src/command.ts:56