Class CommandManager

constructor

• new CommandManager(options): CommandManager

• Parameters

  • options: CommandManagerOptions

  Returns CommandManager

autoComplete

chatInput

Readonly client

componentCommands

Readonly directories

jobs

listeners

messageContextMenus

userContextMenus

apiCommands

• get apiCommands(): Collection<string, APICommandType>

• Returns Collection<string, APICommandType>

commandSize

• get commandSize(): number

• Returns number

developmentCommandData

• get developmentCommandData(): (APISlashCommandData | ContextMenuCommandBuilder)[]

• Represents Discord command API data that is only active in pre-configured development server(s)

  Returns (APISlashCommandData | ContextMenuCommandBuilder)[]

globalCommandData

• get globalCommandData(): (APISlashCommandData | ContextMenuCommandBuilder)[]

• Returns an array of concatenated global data ready to send of to Discord's API

  Returns (APISlashCommandData | ContextMenuCommandBuilder)[]

categoryEmbeds

• categoryEmbeds(category, commands): Promise<EmbedBuilder[]>

• Parameters

  • category: string
  • commands: Collection<string, CommandType>

  Returns Promise<EmbedBuilder[]>

clearCommands

• clearCommands(type): Promise<unknown>

• Parameters

  • type: DeployCommandsType

  Returns Promise<unknown>

commandAPIData

• commandAPIData(): Promise<undefined | Collection<string, ApplicationCommand<{
      guild: GuildResolvable;
  }>>>

• Returns Promise<undefined | Collection<string, ApplicationCommand<{
      guild: GuildResolvable;
  }>>>

commandById

• commandById(id): undefined | ChatInputCommand<ChatInputCommandInteraction<CacheType>> | UserContextCommand<UserContextMenuCommandInteraction<CacheType>> | MessageContextCommand<MessageContextMenuCommandInteraction<CacheType>> | ComponentCommandBase<BaseInteraction<CacheType>>

• Find a command by name across all command collections

  Note: Doesn't use this#apiCommands, as APICommandType doesn't include ComponentCommands

  Parameters

  • id: string

  Returns undefined | ChatInputCommand<ChatInputCommandInteraction<CacheType>> | UserContextCommand<UserContextMenuCommandInteraction<CacheType>> | MessageContextCommand<MessageContextMenuCommandInteraction<CacheType>> | ComponentCommandBase<BaseInteraction<CacheType>>

commandEmbed

• commandEmbed(cmd): EmbedBuilder

• Parameters

  • cmd: CommandType

  Returns EmbedBuilder

commandLink

• commandLink(cmdName, subCmdName?): Promise<string>

• Tries to display commands using Discord's built-in clickable command links, uses default name if otherwise

  Parameters

  • cmdName: string
  • Optional subCmdName: string

  Returns Promise<string>

debugAPICommandData

• debugAPICommandData(type, commands): void

• Parameters

  • type: DeployCommandsType
  • commands: APICommandData[]

  Returns void

debugInternalCommands

• debugInternalCommands(): void

• Returns void

deployCommands

• deployCommands(options): Promise<DeployCommandsResult>

• Parameters

  • options: DeployCommandsOptions

  Returns Promise<DeployCommandsResult>

developmentCommandFilter

• developmentCommandFilter(command): boolean

• Parameters

  • command: APICommandType

  Returns boolean

fetchApplicationCommands

• fetchApplicationCommands(options): Promise<undefined | Collection<string, ApplicationCommand<{
      guild: GuildResolvable;
  }>>>

• Parameters

  • options: DeployCommandsOptions

  Returns Promise<undefined | Collection<string, ApplicationCommand<{
      guild: GuildResolvable;
  }>>>

findChangesInCommands

• findChangesInCommands(newCommandState, applicationCommandsFromFile): {
      command: string;
      key: string;
      newValue: unknown;
      oldValue: unknown;
  }[]

• Parameters

  • newCommandState: APICommandData[]
  • applicationCommandsFromFile: APICommandData[]

  Returns {
      command: string;
      key: string;
      newValue: unknown;
      oldValue: unknown;
  }[]

findCommandsInFolder

• findCommandsInFolder<T>(dirPath): Collection<string, T>

• Type Parameters

  • T extends CommandType

  Parameters

  • dirPath: Directories

  Returns Collection<string, T>

globalCommandFilter

• globalCommandFilter(command): boolean

• Parameters

  • command: APICommandType

  Returns boolean

initialize

• initialize(__namedParameters): {
      autoCompletesCollection: Collection<string, AutoCompleteOption<undefined>>;
      chatInputsCollection: Collection<string, ChatInputCommand<ChatInputCommandInteraction<CacheType>>>;
      componentCommandsCollection: Collection<string, ComponentCommandBase<BaseInteraction<CacheType>>>;
      jobsCollection: Collection<string, Job>;
      listenersCollection: Collection<string, ClientEventListener<keyof ClientEvents>>;
      messageContextMenusCollection: Collection<string, MessageContextCommand<MessageContextMenuCommandInteraction<CacheType>>>;
      userContextMenusCollection: Collection<string, UserContextCommand<UserContextMenuCommandInteraction<CacheType>>>;
  }

• Parameters

  • __namedParameters: CommandManagerCommandsOptions

  Returns {
      autoCompletesCollection: Collection<string, AutoCompleteOption<undefined>>;
      chatInputsCollection: Collection<string, ChatInputCommand<ChatInputCommandInteraction<CacheType>>>;
      componentCommandsCollection: Collection<string, ComponentCommandBase<BaseInteraction<CacheType>>>;
      jobsCollection: Collection<string, Job>;
      listenersCollection: Collection<string, ClientEventListener<keyof ClientEvents>>;
      messageContextMenusCollection: Collection<string, MessageContextCommand<MessageContextMenuCommandInteraction<CacheType>>>;
      userContextMenusCollection: Collection<string, UserContextCommand<UserContextMenuCommandInteraction<CacheType>>>;
  }

  • autoCompletesCollection: Collection<string, AutoCompleteOption<undefined>>

  • chatInputsCollection: Collection<string, ChatInputCommand<ChatInputCommandInteraction<CacheType>>>

  • componentCommandsCollection: Collection<string, ComponentCommandBase<BaseInteraction<CacheType>>>

  • jobsCollection: Collection<string, Job>

  • listenersCollection: Collection<string, ClientEventListener<keyof ClientEvents>>

  • messageContextMenusCollection: Collection<string, MessageContextCommand<MessageContextMenuCommandInteraction<CacheType>>>

  • userContextMenusCollection: Collection<string, UserContextCommand<UserContextMenuCommandInteraction<CacheType>>>

isAppropriateCommandFilter

• isAppropriateCommandFilter(cmd, member, memberPermLevel): boolean

• Parameters

  • cmd: CommandType
  • member: null | GuildMember | APIInteractionGuildMember
  • memberPermLevel: PermLevel

  Returns boolean

loadCommandCollection

• loadCommandCollection<T>(dirPath, collection): {
      added: T[];
      collection: Collection<string, T>;
  }

• Recursively finds and loads all Commands from a given path

  Type Parameters

  • T extends CommandType

  Parameters

  • dirPath: Directories
  • collection: Collection<string, T>

  Returns {
      added: T[];
      collection: Collection<string, T>;
  }

  • added: T[]

  • collection: Collection<string, T>

mapCommandsByCategory

• mapCommandsByCategory(commands): Collection<string, Collection<string, CommandType>>

• Parameters

  • commands: Collection<string, CommandType>

  Returns Collection<string, Collection<string, CommandType>>

mapDataCallback

• mapDataCallback(command): APISlashCommandData | ContextMenuCommandBuilder

• Parameters

  • command: APICommandType

  Returns APISlashCommandData | ContextMenuCommandBuilder

putCommands

• putCommands(route, commands, type, options?): Promise<unknown>

• Parameters

  • route: `/${string}`
  • commands: APICommandData[]
  • type: DeployCommandsType
  • Optional options: Omit<Partial<RequestData>, "body">

  Returns Promise<unknown>

refreshCommandData

• refreshCommandData(): Promise<boolean>

• Check if any changes have been made to the commands since the last time we deployed them, and if so, deploy the changes

  Returns Promise<boolean>

  Wether or not the commands have been deployed because of changes

resolveAliases

• resolveAliases(command): CommandType[]

• Load defined aliases for this command, does nothing if aliases array is empty

  Parameters

  • command: CommandType

  Returns CommandType[]

  A list of Commands that are aliases of this command

resolveAutoCompletes

• resolveAutoCompletes(pathOrPaths, collection): {
      added: any[];
      collection: Collection<string, AutoCompleteOption<undefined>>;
  }

• Parameters

  • pathOrPaths: Directories
  • collection: Collection<string, AutoCompleteOption<undefined>>

  Returns {
      added: any[];
      collection: Collection<string, AutoCompleteOption<undefined>>;
  }

  • added: any[]

  • collection: Collection<string, AutoCompleteOption<undefined>>

resolveCommandId

• resolveCommandId(interaction): string

• Parameters

  • interaction: BaseInteraction<CacheType>

  Returns string

resolveDeployCommandOptions

• resolveDeployCommandOptions(guildId?): DeployCommandsOptions

• Parameters

  • Optional guildId: string

  Returns DeployCommandsOptions

resolveJobs

• resolveJobs(pathOrPaths, collection): {
      added: any[];
      collection: Collection<string, Job>;
  }

• Parameters

  • pathOrPaths: Directories
  • collection: Collection<string, Job>

  Returns {
      added: any[];
      collection: Collection<string, Job>;
  }

  • added: any[]

  • collection: Collection<string, Job>

resolveListeners

• resolveListeners(pathOrPaths, collection): {
      added: any[];
      collection: Collection<string, ClientEventListener<keyof ClientEvents>>;
  }

• Parameters

  • pathOrPaths: Directories
  • collection: Collection<string, ClientEventListener<keyof ClientEvents>>

  Returns {
      added: any[];
      collection: Collection<string, ClientEventListener<keyof ClientEvents>>;
  }

  • added: any[]

  • collection: Collection<string, ClientEventListener<keyof ClientEvents>>