Class CommandBase<Type, GuildOnly, RefuseUncached, ReturnType, ResolveType>

Type Parameters

Type extends CommandType
GuildOnly extends boolean
RefuseUncached extends boolean
ReturnType
ResolveType extends NonNullable<unknown> | null

Hierarchy (View Summary)

CommandBase
- Command

Constructors

`Protected`constructor

new CommandBase<
    Type extends CommandType,
    GuildOnly extends boolean,
    RefuseUncached extends boolean,
    ReturnType,
    ResolveType extends null | {},
>(
    options: CommandOptions<
        Type,
        GuildOnly,
        RefuseUncached,
        ReturnType,
        ResolveType,
    >,
): CommandBase<Type, GuildOnly, RefuseUncached, ReturnType, ResolveType>
Type Parameters
- Type extends CommandType
- GuildOnly extends boolean
- RefuseUncached extends boolean
- ReturnType
- ResolveType extends null | {}
Parameters
- options: CommandOptions<Type, GuildOnly, RefuseUncached, ReturnType, ResolveType>
Returns CommandBase<Type, GuildOnly, RefuseUncached, ReturnType, ResolveType>
- Defined in src/core/commands/base.ts:108

Properties

`Readonly`category

category: string

`Readonly`controllers

controllers: Record<
    string,
    CommandController<
        ReturnType,
        CommandInteraction<Type, CacheTypeResolver<GuildOnly, RefuseUncached>>,
    >,
>

`Readonly`data

data: CommandData<Type>

`Protected` `Readonly`debug

debug: Debugger

`Readonly`enabled

enabled: CommandEnabledOptions<GuildOnly>

`Readonly`id

id: string

`Readonly`idWithoutPrefix

idWithoutPrefix: string

`Readonly`type

type: Type

`Protected` `Static` `Readonly`defaults

defaults: {
    enabled: { global: boolean; nsfw: boolean } & {
        dm: boolean;
        guildOnly: false;
        guilds: boolean | string[];
        privateChannel: boolean;
    };
    interactions: CommandInteractionOptions<false>;
    permissions: CommandPermissionOptions;
    throttle: CommandThrottleOptions;
} = commandDefaults

Accessors

registry

get registry(): AnyCommand<CommandType>[]
Returns AnyCommand<CommandType>[]
- Defined in src/core/commands/base.ts:368

Methods

`Readonly`extend

extend<
    T extends CommandType,
    GO extends boolean = GuildOnly,
    RU extends boolean = RefuseUncached,
    RT = unknown,
    RST extends null | {} = null,
>(
    options: CommandOptions<T, GO, RU, RT, RST>,
): Command<T, GO, RU, RT, RST>
Type Parameters
- T extends CommandType
- GO extends boolean = GuildOnly
- RU extends boolean = RefuseUncached
- RT = unknown
- RST extends null | {} = null
Parameters
- options: CommandOptions<T, GO, RU, RT, RST>
Returns Command<T, GO, RU, RT, RST>
- Defined in src/core/commands/base.ts:375

`Readonly`extendRaw

extendRaw(
command: Command,
): Command<CommandType, boolean, boolean, unknown, null>
Parameters
- command: Command
Returns Command<CommandType, boolean, boolean, unknown, null>
- Defined in src/core/commands/base.ts:460

`Readonly`extends

extends<
    T extends CommandType,
    GO extends boolean = GuildOnly,
    RU extends boolean = RefuseUncached,
    RT = unknown,
    RST extends null | {} = null,
>(
    command: Command<T, GO, RU, RT, RST>,
): Command<T, GO, RU, RT, RST>
Type Parameters
- T extends CommandType
- GO extends boolean = GuildOnly
- RU extends boolean = RefuseUncached
- RT = unknown
- RST extends null | {} = null
Parameters
- command: Command<T, GO, RU, RT, RST>
Returns Command<T, GO, RU, RT, RST>
- Defined in src/core/commands/base.ts:404

`Readonly`reply

reply<I extends RepliableInteraction, WithResponse extends boolean = false>(
    interaction: I,
    content: WithResponseContent<WithResponse>,
    withResponse?: WithResponse,
    ephemeral?: boolean,
): Promise<WithResponseType<WithResponse>>
Reply to an interaction with a message, dynamically resolving which reply function to use depending on wether or not the interaction has been acknowledged. ephemeral is resolved from this#isEphemeral if not overriden.

Please note that using MessageFlags in the content is not supported with a dynamic function like this. If you need specific flags, use reply, editReply, followUp, etc. directly, instead of using this convenience method.
Type Parameters
- I extends RepliableInteraction
- WithResponse extends boolean = false
Parameters
- interaction: I
- content: WithResponseContent<WithResponse>
- OptionalwithResponse: WithResponse
- Optionalephemeral: boolean
Returns Promise<WithResponseType<WithResponse>>
- Defined in src/core/commands/base.ts:340

`Readonly`response

response<WithResponse extends boolean = false>(
    content: WithResponseContent<WithResponse>,
    withResponse?: WithResponse,
    ephemeral?: boolean,
): ResponseContent
Type Parameters
- WithResponse extends boolean = false
Parameters
- content: WithResponseContent<WithResponse>
- OptionalwithResponse: WithResponse
- Optionalephemeral: boolean
Returns ResponseContent
- Defined in src/core/commands/base.ts:356

toString

toString(): string
Returns string
- Defined in src/core/commands/base.ts:102

`Readonly`withThrottle

withThrottle<T extends () => unknown>(
    consumer: ThrottleConsumer,
    fn: T,
    throttleAutoComplete?: boolean,
): Promise<readonly [unknown, ThrottleConsumerResult]>
Run a function, throttled by the configured throttle options.
Type Parameters
- T extends () => unknown
Parameters
- consumer: ThrottleConsumer
  The function to be called before the throttled function is executed, should return wether or not to proceed to fn.
- fn: T
  The function to be executed, can return a value or a promise. Not executed if before returns false.
- throttleAutoComplete: boolean = false
  Whether or not to throttle auto-complete commands. If set to false, the function will be executed immediately.
Returns Promise<readonly [unknown, ThrottleConsumerResult]>
A tuple of the result of the fn function and a promise for the after function.
- Defined in src/core/commands/base.ts:679

`Static` `Readonly`build

build(command: AnyCommand): AnyCommand
Parameters
- command: AnyCommand
Returns AnyCommand
- Defined in src/core/commands/base.ts:520

`Static` `Readonly`commandIdentifierFor

commandIdentifierFor<I extends Interaction<CacheType>>(interaction: I): string
Type Parameters
- I extends Interaction<CacheType>
Parameters
- interaction: I
Returns string
- Defined in src/core/commands/base.ts:281

`Protected` `Static` `Readonly`dataResolver

dataResolver<Type extends CommandType>(
    type: Type,
    _data:
        | CommandData<Type>
        | (builder: CommandData<Type>) => CommandData<Type>,
): CommandData<Type>
Type Parameters
- Type extends CommandType
Parameters
- type: Type
- _data: CommandData<Type> | (builder: CommandData<Type>) => CommandData<Type>
Returns CommandData<Type>
- Defined in src/core/commands/base.ts:802

`Protected` `Static` `Readonly`deferReply

deferReply<Interaction extends RepliableInteraction>(
interaction: Interaction,
ephemeral: boolean,
): Promise<void>
Type Parameters
- Interaction extends RepliableInteraction
Parameters
- interaction: Interaction
- ephemeral: boolean
Returns Promise<void>
- Defined in src/core/commands/base.ts:212

`Static` `Readonly`findInApiData

findInApiData(
    id: string,
    data: (
        | RESTPostAPIChatInputApplicationCommandsJSONBody
        | RESTPostAPIContextMenuApplicationCommandsJSONBody
    )[],
): | undefined
| RESTPostAPIChatInputApplicationCommandsJSONBody
| RESTPostAPIContextMenuApplicationCommandsJSONBody
Parameters
- id: string
- data: (
  | RESTPostAPIChatInputApplicationCommandsJSONBody
  | RESTPostAPIContextMenuApplicationCommandsJSONBody
  )[]
Returns
    | undefined
    | RESTPostAPIChatInputApplicationCommandsJSONBody
    | RESTPostAPIContextMenuApplicationCommandsJSONBody
- Defined in src/core/commands/base.ts:792

`Static` `Readonly`getContexts

getContexts(command: APICommand): InteractionContextType[]
Parameters
- command: APICommand
Returns InteractionContextType[]
- Defined in src/core/commands/base.ts:466

`Static` `Readonly`getIntegrationTypes

getIntegrationTypes(
command: APICommand,
contexts: InteractionContextType[],
): ApplicationIntegrationType[]
Parameters
- command: APICommand
- contexts: InteractionContextType[]
Returns ApplicationIntegrationType[]
- Defined in src/core/commands/base.ts:499

`Static` `Readonly`handleInteraction

handleInteraction<
    Type extends CommandType,
    GuildOnly extends boolean,
    RefuseUncached extends boolean,
    ReturnType,
>(
    command: Command<Type, GuildOnly, RefuseUncached, ReturnType>,
    interaction: CommandInteraction<CommandType>,
): Promise<
    | [
        | "discord.memberCount"
        | "discord.joinedServer"
        | "discord.joinedDiscord"
        | "discord.accountCreated"
        | "discord.messageHasNoEmbeds"
        | "discord.memberJoined.description"
        | "discord.memberJoined.title"
        | "discord.memberLeft.description"
        | "discord.memberLeft.title"
        | "commands.error"
        | "commands.disabled"
        | "commands.guildOnly"
        | "commands.cachedGuildOnly"
        | "commands.nsfwChannelOnly"
        | "commands.notTargetUser"
        | "commands.noOptionSelected"
        | "permissions.yourLevel"
        | "permissions.theirLevel"
        | "permissions.levelTooLow"
        | "permissions.missingBotScope"
        | "permissions.missingPermissions"
        | "permissions.botMissingPermissions"
        | "permissions.unavailable.guild"
        | "permissions.unavailable.channel"
        | "permissions.unavailable.cachedGuild"
        | "permissions.unavailable.channelCategory"
        | "permissions.unavailable.missingRoles"
        | "permissions.unavailable.unauthorized"
        | "permissions.unavailable.disabledByServer"
        | "permissions.levels.User"
        | "permissions.levels.Moderator"
        | "permissions.levels.Administrator"
        | "permissions.levels.Server Owner"
        | "permissions.levels.Developer"
        | "permissions.levels.Bot Administrator"
        | "permissions.levels.Bot Owner"
        | "core:discord.memberCount"
        | "core:discord.joinedServer"
        | "core:discord.joinedDiscord"
        | "core:discord.accountCreated"
        | "core:discord.messageHasNoEmbeds"
        | "core:discord.memberJoined.description"
        | "core:discord.memberJoined.title"
        | "core:discord.memberLeft.description"
        | "core:discord.memberLeft.title"
        | "core:commands.error"
        | "core:commands.disabled"
        | "core:commands.guildOnly"
        | "core:commands.cachedGuildOnly"
        | "core:commands.nsfwChannelOnly"
        | "core:commands.notTargetUser"
        | "core:commands.noOptionSelected"
        | "core:permissions.yourLevel"
        | "core:permissions.theirLevel"
        | "core:permissions.levelTooLow"
        | "core:permissions.missingBotScope"
        | "core:permissions.missingPermissions"
        | "core:permissions.botMissingPermissions"
        | "core:permissions.unavailable.guild"
        | "core:permissions.unavailable.channel"
        | "core:permissions.unavailable.cachedGuild"
        | "core:permissions.unavailable.channelCategory"
        | "core:permissions.unavailable.missingRoles"
        | "core:permissions.unavailable.unauthorized"
        | "core:permissions.unavailable.disabledByServer"
        | "core:permissions.levels.User"
        | "core:permissions.levels.Moderator"
        | "core:permissions.levels.Administrator"
        | "core:permissions.levels.Server Owner"
        | "core:permissions.levels.Developer"
        | "core:permissions.levels.Bot Administrator"
        | "core:permissions.levels.Bot Owner"
        | "common:time.runtime"
        | "common:time.singular.seconds"
        | "common:time.singular.minutes"
        | "common:time.singular.hours"
        | "common:time.singular.days"
        | "common:time.plural.seconds"
        | "common:time.plural.minutes"
        | "common:time.plural.hours"
        | "common:time.plural.days"
        | "common:word.archived"
        | "common:word.pending"
        | "common:word.info"
        | "common:word.unknown"
        | "common:word.error"
        | "common:word.disabled"
        | "common:word.unavailable"
        | "common:word.none"
        | "common:word.loading"
        | "common:word.success"
        | "common:word.warning"
        | "common:word.yes"
        | "common:word.no"
        | "common:word.on"
        | "common:word.off"
        | "common:word.enabled"
        | "common:word.active"
        | "common:word.inactive"
        | "common:word.online"
        | "common:word.offline"
        | "common:word.available"
        | "common:word.connected"
        | "common:word.disconnected"
        | "common:word.completed"
        | "common:word.failed"
        | "common:word.cancelled"
        | "common:word.accepted"
        | "common:word.rejected"
        | "common:word.created"
        | "common:word.updated"
        | "common:word.deleted"
        | "common:word.restored"
        | "common:word.added"
        | "common:word.removed"
        | "common:word.changed"
        | "common:word.modified"
        | "common:word.viewed"
        | "common:word.opened"
        | "common:word.closed"
        | "common:word.started"
        | "common:word.stopped"
        | "common:word.paused"
        | "common:word.resumed"
        | "common:word.finished"
        | "common:word.startedAt"
        | "common:word.stoppedAt"
        | "common:word.pausedAt"
        | "common:word.resumedAt"
        | "common:word.finishedAt"
        | "common:actions.delete"
        | "common:actions.edit"
        | "common:actions.cancel"
        | "common:actions.confirm"
        | "common:actions.save"
        | "common:actions.close"
        | "common:confirmation.cancel.message"
        | "common:confirmation.cancel.title"
        | "common:confirmation.confirm.message"
        | "common:confirmation.confirm.title"
        | "common:confirmation.prompt.message"
        | "common:confirmation.prompt.title"
        | "common:errors.tryAgainLater"
        | "common:errors.issueReportedToSupport"
        | "common:errors.rateLimit.message"
        | "common:errors.rateLimit.title",
        null
        | Record<string, string>,
    ]
    | CommandInteraction<Type, CacheTypeResolver<GuildOnly, RefuseUncached>>,
>
Type Parameters
- Type extends CommandType
- GuildOnly extends boolean
- RefuseUncached extends boolean
- ReturnType
Parameters
- command: Command<Type, GuildOnly, RefuseUncached, ReturnType>
- interaction: CommandInteraction<CommandType>
Returns Promise<
    | [
        | "discord.memberCount"
        | "discord.joinedServer"
        | "discord.joinedDiscord"
        | "discord.accountCreated"
        | "discord.messageHasNoEmbeds"
        | "discord.memberJoined.description"
        | "discord.memberJoined.title"
        | "discord.memberLeft.description"
        | "discord.memberLeft.title"
        | "commands.error"
        | "commands.disabled"
        | "commands.guildOnly"
        | "commands.cachedGuildOnly"
        | "commands.nsfwChannelOnly"
        | "commands.notTargetUser"
        | "commands.noOptionSelected"
        | "permissions.yourLevel"
        | "permissions.theirLevel"
        | "permissions.levelTooLow"
        | "permissions.missingBotScope"
        | "permissions.missingPermissions"
        | "permissions.botMissingPermissions"
        | "permissions.unavailable.guild"
        | "permissions.unavailable.channel"
        | "permissions.unavailable.cachedGuild"
        | "permissions.unavailable.channelCategory"
        | "permissions.unavailable.missingRoles"
        | "permissions.unavailable.unauthorized"
        | "permissions.unavailable.disabledByServer"
        | "permissions.levels.User"
        | "permissions.levels.Moderator"
        | "permissions.levels.Administrator"
        | "permissions.levels.Server Owner"
        | "permissions.levels.Developer"
        | "permissions.levels.Bot Administrator"
        | "permissions.levels.Bot Owner"
        | "core:discord.memberCount"
        | "core:discord.joinedServer"
        | "core:discord.joinedDiscord"
        | "core:discord.accountCreated"
        | "core:discord.messageHasNoEmbeds"
        | "core:discord.memberJoined.description"
        | "core:discord.memberJoined.title"
        | "core:discord.memberLeft.description"
        | "core:discord.memberLeft.title"
        | "core:commands.error"
        | "core:commands.disabled"
        | "core:commands.guildOnly"
        | "core:commands.cachedGuildOnly"
        | "core:commands.nsfwChannelOnly"
        | "core:commands.notTargetUser"
        | "core:commands.noOptionSelected"
        | "core:permissions.yourLevel"
        | "core:permissions.theirLevel"
        | "core:permissions.levelTooLow"
        | "core:permissions.missingBotScope"
        | "core:permissions.missingPermissions"
        | "core:permissions.botMissingPermissions"
        | "core:permissions.unavailable.guild"
        | "core:permissions.unavailable.channel"
        | "core:permissions.unavailable.cachedGuild"
        | "core:permissions.unavailable.channelCategory"
        | "core:permissions.unavailable.missingRoles"
        | "core:permissions.unavailable.unauthorized"
        | "core:permissions.unavailable.disabledByServer"
        | "core:permissions.levels.User"
        | "core:permissions.levels.Moderator"
        | "core:permissions.levels.Administrator"
        | "core:permissions.levels.Server Owner"
        | "core:permissions.levels.Developer"
        | "core:permissions.levels.Bot Administrator"
        | "core:permissions.levels.Bot Owner"
        | "common:time.runtime"
        | "common:time.singular.seconds"
        | "common:time.singular.minutes"
        | "common:time.singular.hours"
        | "common:time.singular.days"
        | "common:time.plural.seconds"
        | "common:time.plural.minutes"
        | "common:time.plural.hours"
        | "common:time.plural.days"
        | "common:word.archived"
        | "common:word.pending"
        | "common:word.info"
        | "common:word.unknown"
        | "common:word.error"
        | "common:word.disabled"
        | "common:word.unavailable"
        | "common:word.none"
        | "common:word.loading"
        | "common:word.success"
        | "common:word.warning"
        | "common:word.yes"
        | "common:word.no"
        | "common:word.on"
        | "common:word.off"
        | "common:word.enabled"
        | "common:word.active"
        | "common:word.inactive"
        | "common:word.online"
        | "common:word.offline"
        | "common:word.available"
        | "common:word.connected"
        | "common:word.disconnected"
        | "common:word.completed"
        | "common:word.failed"
        | "common:word.cancelled"
        | "common:word.accepted"
        | "common:word.rejected"
        | "common:word.created"
        | "common:word.updated"
        | "common:word.deleted"
        | "common:word.restored"
        | "common:word.added"
        | "common:word.removed"
        | "common:word.changed"
        | "common:word.modified"
        | "common:word.viewed"
        | "common:word.opened"
        | "common:word.closed"
        | "common:word.started"
        | "common:word.stopped"
        | "common:word.paused"
        | "common:word.resumed"
        | "common:word.finished"
        | "common:word.startedAt"
        | "common:word.stoppedAt"
        | "common:word.pausedAt"
        | "common:word.resumedAt"
        | "common:word.finishedAt"
        | "common:actions.delete"
        | "common:actions.edit"
        | "common:actions.cancel"
        | "common:actions.confirm"
        | "common:actions.save"
        | "common:actions.close"
        | "common:confirmation.cancel.message"
        | "common:confirmation.cancel.title"
        | "common:confirmation.confirm.message"
        | "common:confirmation.confirm.title"
        | "common:confirmation.prompt.message"
        | "common:confirmation.prompt.title"
        | "common:errors.tryAgainLater"
        | "common:errors.issueReportedToSupport"
        | "common:errors.rateLimit.message"
        | "common:errors.rateLimit.title",
        null
        | Record<string, string>,
    ]
    | CommandInteraction<Type, CacheTypeResolver<GuildOnly, RefuseUncached>>,
>
- Defined in src/core/commands/base.ts:998

`Protected` `Static` `Readonly`handlePermissions

handlePermissions<
    Type extends CommandType,
    GuildOnly extends boolean,
    RefuseUncached extends boolean,
    ReturnType,
>(
    command: Command<Type, GuildOnly, RefuseUncached, ReturnType>,
    interaction: CommandInteraction,
): Promise<
    | true
    | [
        | "discord.memberCount"
        | "discord.joinedServer"
        | "discord.joinedDiscord"
        | "discord.accountCreated"
        | "discord.messageHasNoEmbeds"
        | "discord.memberJoined.description"
        | "discord.memberJoined.title"
        | "discord.memberLeft.description"
        | "discord.memberLeft.title"
        | "commands.error"
        | "commands.disabled"
        | "commands.guildOnly"
        | "commands.cachedGuildOnly"
        | "commands.nsfwChannelOnly"
        | "commands.notTargetUser"
        | "commands.noOptionSelected"
        | "permissions.yourLevel"
        | "permissions.theirLevel"
        | "permissions.levelTooLow"
        | "permissions.missingBotScope"
        | "permissions.missingPermissions"
        | "permissions.botMissingPermissions"
        | "permissions.unavailable.guild"
        | "permissions.unavailable.channel"
        | "permissions.unavailable.cachedGuild"
        | "permissions.unavailable.channelCategory"
        | "permissions.unavailable.missingRoles"
        | "permissions.unavailable.unauthorized"
        | "permissions.unavailable.disabledByServer"
        | "permissions.levels.User"
        | "permissions.levels.Moderator"
        | "permissions.levels.Administrator"
        | "permissions.levels.Server Owner"
        | "permissions.levels.Developer"
        | "permissions.levels.Bot Administrator"
        | "permissions.levels.Bot Owner"
        | "core:discord.memberCount"
        | "core:discord.joinedServer"
        | "core:discord.joinedDiscord"
        | "core:discord.accountCreated"
        | "core:discord.messageHasNoEmbeds"
        | "core:discord.memberJoined.description"
        | "core:discord.memberJoined.title"
        | "core:discord.memberLeft.description"
        | "core:discord.memberLeft.title"
        | "core:commands.error"
        | "core:commands.disabled"
        | "core:commands.guildOnly"
        | "core:commands.cachedGuildOnly"
        | "core:commands.nsfwChannelOnly"
        | "core:commands.notTargetUser"
        | "core:commands.noOptionSelected"
        | "core:permissions.yourLevel"
        | "core:permissions.theirLevel"
        | "core:permissions.levelTooLow"
        | "core:permissions.missingBotScope"
        | "core:permissions.missingPermissions"
        | "core:permissions.botMissingPermissions"
        | "core:permissions.unavailable.guild"
        | "core:permissions.unavailable.channel"
        | "core:permissions.unavailable.cachedGuild"
        | "core:permissions.unavailable.channelCategory"
        | "core:permissions.unavailable.missingRoles"
        | "core:permissions.unavailable.unauthorized"
        | "core:permissions.unavailable.disabledByServer"
        | "core:permissions.levels.User"
        | "core:permissions.levels.Moderator"
        | "core:permissions.levels.Administrator"
        | "core:permissions.levels.Server Owner"
        | "core:permissions.levels.Developer"
        | "core:permissions.levels.Bot Administrator"
        | "core:permissions.levels.Bot Owner"
        | "common:time.runtime"
        | "common:time.singular.seconds"
        | "common:time.singular.minutes"
        | "common:time.singular.hours"
        | "common:time.singular.days"
        | "common:time.plural.seconds"
        | "common:time.plural.minutes"
        | "common:time.plural.hours"
        | "common:time.plural.days"
        | "common:word.archived"
        | "common:word.pending"
        | "common:word.info"
        | "common:word.unknown"
        | "common:word.error"
        | "common:word.disabled"
        | "common:word.unavailable"
        | "common:word.none"
        | "common:word.loading"
        | "common:word.success"
        | "common:word.warning"
        | "common:word.yes"
        | "common:word.no"
        | "common:word.on"
        | "common:word.off"
        | "common:word.enabled"
        | "common:word.active"
        | "common:word.inactive"
        | "common:word.online"
        | "common:word.offline"
        | "common:word.available"
        | "common:word.connected"
        | "common:word.disconnected"
        | "common:word.completed"
        | "common:word.failed"
        | "common:word.cancelled"
        | "common:word.accepted"
        | "common:word.rejected"
        | "common:word.created"
        | "common:word.updated"
        | "common:word.deleted"
        | "common:word.restored"
        | "common:word.added"
        | "common:word.removed"
        | "common:word.changed"
        | "common:word.modified"
        | "common:word.viewed"
        | "common:word.opened"
        | "common:word.closed"
        | "common:word.started"
        | "common:word.stopped"
        | "common:word.paused"
        | "common:word.resumed"
        | "common:word.finished"
        | "common:word.startedAt"
        | "common:word.stoppedAt"
        | "common:word.pausedAt"
        | "common:word.resumedAt"
        | "common:word.finishedAt"
        | "common:actions.delete"
        | "common:actions.edit"
        | "common:actions.cancel"
        | "common:actions.confirm"
        | "common:actions.save"
        | "common:actions.close"
        | "common:confirmation.cancel.message"
        | "common:confirmation.cancel.title"
        | "common:confirmation.confirm.message"
        | "common:confirmation.confirm.title"
        | "common:confirmation.prompt.message"
        | "common:confirmation.prompt.title"
        | "common:errors.tryAgainLater"
        | "common:errors.issueReportedToSupport"
        | "common:errors.rateLimit.message"
        | "common:errors.rateLimit.title",
        null
        | Record<string, string>,
    ],
>
Type Parameters
- Type extends CommandType
- GuildOnly extends boolean
- RefuseUncached extends boolean
- ReturnType
Parameters
- command: Command<Type, GuildOnly, RefuseUncached, ReturnType>
- interaction: CommandInteraction
Returns Promise<
    | true
    | [
        | "discord.memberCount"
        | "discord.joinedServer"
        | "discord.joinedDiscord"
        | "discord.accountCreated"
        | "discord.messageHasNoEmbeds"
        | "discord.memberJoined.description"
        | "discord.memberJoined.title"
        | "discord.memberLeft.description"
        | "discord.memberLeft.title"
        | "commands.error"
        | "commands.disabled"
        | "commands.guildOnly"
        | "commands.cachedGuildOnly"
        | "commands.nsfwChannelOnly"
        | "commands.notTargetUser"
        | "commands.noOptionSelected"
        | "permissions.yourLevel"
        | "permissions.theirLevel"
        | "permissions.levelTooLow"
        | "permissions.missingBotScope"
        | "permissions.missingPermissions"
        | "permissions.botMissingPermissions"
        | "permissions.unavailable.guild"
        | "permissions.unavailable.channel"
        | "permissions.unavailable.cachedGuild"
        | "permissions.unavailable.channelCategory"
        | "permissions.unavailable.missingRoles"
        | "permissions.unavailable.unauthorized"
        | "permissions.unavailable.disabledByServer"
        | "permissions.levels.User"
        | "permissions.levels.Moderator"
        | "permissions.levels.Administrator"
        | "permissions.levels.Server Owner"
        | "permissions.levels.Developer"
        | "permissions.levels.Bot Administrator"
        | "permissions.levels.Bot Owner"
        | "core:discord.memberCount"
        | "core:discord.joinedServer"
        | "core:discord.joinedDiscord"
        | "core:discord.accountCreated"
        | "core:discord.messageHasNoEmbeds"
        | "core:discord.memberJoined.description"
        | "core:discord.memberJoined.title"
        | "core:discord.memberLeft.description"
        | "core:discord.memberLeft.title"
        | "core:commands.error"
        | "core:commands.disabled"
        | "core:commands.guildOnly"
        | "core:commands.cachedGuildOnly"
        | "core:commands.nsfwChannelOnly"
        | "core:commands.notTargetUser"
        | "core:commands.noOptionSelected"
        | "core:permissions.yourLevel"
        | "core:permissions.theirLevel"
        | "core:permissions.levelTooLow"
        | "core:permissions.missingBotScope"
        | "core:permissions.missingPermissions"
        | "core:permissions.botMissingPermissions"
        | "core:permissions.unavailable.guild"
        | "core:permissions.unavailable.channel"
        | "core:permissions.unavailable.cachedGuild"
        | "core:permissions.unavailable.channelCategory"
        | "core:permissions.unavailable.missingRoles"
        | "core:permissions.unavailable.unauthorized"
        | "core:permissions.unavailable.disabledByServer"
        | "core:permissions.levels.User"
        | "core:permissions.levels.Moderator"
        | "core:permissions.levels.Administrator"
        | "core:permissions.levels.Server Owner"
        | "core:permissions.levels.Developer"
        | "core:permissions.levels.Bot Administrator"
        | "core:permissions.levels.Bot Owner"
        | "common:time.runtime"
        | "common:time.singular.seconds"
        | "common:time.singular.minutes"
        | "common:time.singular.hours"
        | "common:time.singular.days"
        | "common:time.plural.seconds"
        | "common:time.plural.minutes"
        | "common:time.plural.hours"
        | "common:time.plural.days"
        | "common:word.archived"
        | "common:word.pending"
        | "common:word.info"
        | "common:word.unknown"
        | "common:word.error"
        | "common:word.disabled"
        | "common:word.unavailable"
        | "common:word.none"
        | "common:word.loading"
        | "common:word.success"
        | "common:word.warning"
        | "common:word.yes"
        | "common:word.no"
        | "common:word.on"
        | "common:word.off"
        | "common:word.enabled"
        | "common:word.active"
        | "common:word.inactive"
        | "common:word.online"
        | "common:word.offline"
        | "common:word.available"
        | "common:word.connected"
        | "common:word.disconnected"
        | "common:word.completed"
        | "common:word.failed"
        | "common:word.cancelled"
        | "common:word.accepted"
        | "common:word.rejected"
        | "common:word.created"
        | "common:word.updated"
        | "common:word.deleted"
        | "common:word.restored"
        | "common:word.added"
        | "common:word.removed"
        | "common:word.changed"
        | "common:word.modified"
        | "common:word.viewed"
        | "common:word.opened"
        | "common:word.closed"
        | "common:word.started"
        | "common:word.stopped"
        | "common:word.paused"
        | "common:word.resumed"
        | "common:word.finished"
        | "common:word.startedAt"
        | "common:word.stoppedAt"
        | "common:word.pausedAt"
        | "common:word.resumedAt"
        | "common:word.finishedAt"
        | "common:actions.delete"
        | "common:actions.edit"
        | "common:actions.cancel"
        | "common:actions.confirm"
        | "common:actions.save"
        | "common:actions.close"
        | "common:confirmation.cancel.message"
        | "common:confirmation.cancel.title"
        | "common:confirmation.confirm.message"
        | "common:confirmation.confirm.title"
        | "common:confirmation.prompt.message"
        | "common:confirmation.prompt.title"
        | "common:errors.tryAgainLater"
        | "common:errors.issueReportedToSupport"
        | "common:errors.rateLimit.message"
        | "common:errors.rateLimit.title",
        null
        | Record<string, string>,
    ],
>
- Defined in src/core/commands/base.ts:864

`Static` `Readonly`isApiCommand

isApiCommand(command: AnyCommand): command is APICommand<APICommandTypeValue>
Parameters
- command: AnyCommand
Returns command is APICommand<APICommandTypeValue>
- Defined in src/core/commands/base.ts:225

`Static` `Readonly`isEnabled

isEnabled(command: AnyCommand): boolean
Parameters
- command: AnyCommand
Returns boolean
- Defined in src/core/commands/base.ts:238

`Static` `Readonly`isNonApiCommand

isNonApiCommand(
command: AnyCommand,
): command is NonAPICommand<NonAPICommandTypeValue>
Parameters
- command: AnyCommand
Returns command is NonAPICommand<NonAPICommandTypeValue>
- Defined in src/core/commands/base.ts:234

`Static` `Readonly`registerLocalization

registerLocalization(command: APICommand): APICommand<APICommandTypeValue>
Parameters
- command: APICommand
Returns APICommand<APICommandTypeValue>
- Defined in src/core/commands/base.ts:559

`Static` `Readonly`resolveDiscordType

resolveDiscordType(type: CommandType): InteractionType
Parameters
- type: CommandType
Returns InteractionType
- Defined in src/core/commands/base.ts:246

`Static` `Readonly`resolveId

resolveId(
    cmd:
        | NonAPICommand<NonAPICommandTypeValue>
        | RESTPostAPIChatInputApplicationCommandsJSONBody
        | RESTPostAPIContextMenuApplicationCommandsJSONBody,
): string
Parameters
- cmd:
      | NonAPICommand<NonAPICommandTypeValue>
      | RESTPostAPIChatInputApplicationCommandsJSONBody
      | RESTPostAPIContextMenuApplicationCommandsJSONBody
Returns string
- Defined in src/core/commands/base.ts:715

`Static` `Readonly`runFunctionResolver

runFunctionResolver<
    Type extends CommandType,
    GuildOnly extends boolean,
    RefuseUncached extends boolean,
    ReturnType,
>(
    command: Command<Type, GuildOnly, RefuseUncached, ReturnType>,
    interaction: CommandInteraction<
        Type,
        CacheTypeResolver<GuildOnly, RefuseUncached>,
    >,
):
    | null
    | CommandRunFunction<
        ReturnType,
        CommandInteraction<Type, CacheTypeResolver<GuildOnly, RefuseUncached>>,
    >
Type Parameters
- Type extends CommandType
- GuildOnly extends boolean
- RefuseUncached extends boolean
- ReturnType
Parameters
- command: Command<Type, GuildOnly, RefuseUncached, ReturnType>
- interaction: CommandInteraction<Type, CacheTypeResolver<GuildOnly, RefuseUncached>>
Returns
    | null
    | CommandRunFunction<
        ReturnType,
        CommandInteraction<Type, CacheTypeResolver<GuildOnly, RefuseUncached>>,
    >
- Defined in src/core/commands/base.ts:1081

Class CommandBase<Type, GuildOnly, RefuseUncached, ReturnType, ResolveType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns CommandBase<Type, GuildOnly, RefuseUncached, ReturnType, ResolveType>

Properties

Readonlycategory

Readonlycontrollers

Readonlydata

Protected Readonlydebug

Readonlyenabled

Readonlyid

ReadonlyidWithoutPrefix

Readonlyinteractions

Readonlypermissions

Readonlyresolver

Readonlythrottle

Readonlytype

Protected Static Readonlydefaults

Accessors

registry

Returns AnyCommand<CommandType>[]

Methods

Readonlyextend

Type Parameters

Parameters

Returns Command<T, GO, RU, RT, RST>

ReadonlyextendRaw

Parameters

Returns Command<CommandType, boolean, boolean, unknown, null>

Readonlyextends

Type Parameters

Parameters

Returns Command<T, GO, RU, RT, RST>

Readonlyreply

Type Parameters

Parameters

Returns Promise<WithResponseType<WithResponse>>

Readonlyresponse

Type Parameters

Parameters

Returns ResponseContent

toString

Returns string

ReadonlywithThrottle

Type Parameters

Parameters

Returns Promise<readonly [unknown, ThrottleConsumerResult]>

Static Readonlybuild

Parameters

Returns AnyCommand

Static ReadonlycommandIdentifierFor

Type Parameters

Parameters

Returns string

Protected Static ReadonlydataResolver

Type Parameters

Parameters

Returns CommandData<Type>

Protected Static ReadonlydeferReply

Type Parameters

Parameters

Returns Promise<void>

Static ReadonlyfindInApiData

Parameters

Returns | undefined | RESTPostAPIChatInputApplicationCommandsJSONBody | RESTPostAPIContextMenuApplicationCommandsJSONBody

Static ReadonlygetContexts

Parameters

Returns InteractionContextType[]

Static ReadonlygetIntegrationTypes

Parameters

Returns ApplicationIntegrationType[]

`Protected`constructor

`Readonly`category

`Readonly`controllers

`Readonly`data

`Protected` `Readonly`debug

`Readonly`enabled

`Readonly`id

`Readonly`idWithoutPrefix

`Readonly`interactions

`Readonly`permissions

`Readonly`resolver

`Readonly`throttle

`Readonly`type

`Protected` `Static` `Readonly`defaults

`Readonly`extend

`Readonly`extendRaw

`Readonly`extends

`Readonly`reply

`Readonly`response

`Readonly`withThrottle

`Static` `Readonly`build

`Static` `Readonly`commandIdentifierFor

`Protected` `Static` `Readonly`dataResolver

`Protected` `Static` `Readonly`deferReply

`Static` `Readonly`findInApiData

Returns
| undefined
| RESTPostAPIChatInputApplicationCommandsJSONBody
| RESTPostAPIContextMenuApplicationCommandsJSONBody

`Static` `Readonly`getContexts

`Static` `Readonly`getIntegrationTypes

`Static` `Readonly`handleInteraction

`Protected` `Static` `Readonly`handlePermissions

`Static` `Readonly`isApiCommand

`Static` `Readonly`isEnabled

`Static` `Readonly`isNonApiCommand

`Static` `Readonly`registerLocalization

`Static` `Readonly`resolveDiscordType

`Static` `Readonly`resolveId

`Static` `Readonly`runFunctionResolver

Returns
| null
| CommandRunFunction<
ReturnType,
CommandInteraction<Type, CacheTypeResolver<GuildOnly, RefuseUncached>>,
>