Class BaseCommand<I>

Represents the base class used for all our commands & components

Type Parameters

  • I extends BaseInteraction = BaseInteraction

Hierarchy (view full)

Constructors

constructor

Properties

_initialized aliasOf aliases category client? clientPerms collection? cooldown data deferReply disabled guildOnly isEphemeral manager? middleware nsfw permLevel requiredResourceIds run sourceFile sourceFileStackTrace sourceHash userPerms

Accessors

initialized

Methods

deferReplyInternal handleInteraction hasAccessToUserComponent initialize load matchComponentOriginConstraints matchConstraints matchDMConstraints matchDiscordPermConstraints matchEnabledConstraints matchNSFWConstraints matchPermLevelConstraints matchPermissionConstraints registerLocalizations reply resolveDescriptionLocalizations resolveLocalizations resolveNameLocalizations throttleUsage unInitialize

Constructors

constructor

Properties

Private _initialized

_initialized: boolean = false

aliasOf

aliasOf: null | CommandType = null

Represents the command this command is an alias of

aliases

aliases: string[] = []

Represents a list of commands that are identical to the original command, with different names

category

category: null | string = null

Optional client

client?: Client<boolean>

clientPerms

clientPerms: never[] = []

Optional collection

collection?: Collection<string, CommandType>

cooldown

cooldown: CommandThrottle

data

data: ComponentCommandData = ...

deferReply

deferReply: boolean = false

disabled

disabled: boolean = false

guildOnly

guildOnly: boolean = true

isEphemeral

isEphemeral: boolean = false

Optional manager

manager?: CommandManager

middleware

middleware: CommandMiddleware<I, CommandMiddlewareContext<I>>

nsfw

nsfw: boolean = false

permLevel

permLevel: PermLevel = PermLevel.User

requiredResourceIds

requiredResourceIds: RequiredResources<I> = ...

run

run: RunFunction<I>

sourceFile

sourceFile: string = DEFAULT_SOURCE_FILE_STRING

sourceFileStackTrace

sourceFileStackTrace: string = DEFAULT_SOURCE_FILE_STRING

sourceHash

sourceHash: string = DEFAULT_SOURCE_FILE_STRING

userPerms

userPerms: never[] = []

Accessors

initialized

Methods

deferReplyInternal

  • deferReplyInternal(interaction): Promise<void>

  • Defers the reply to run interactions internally if possible

    Parameters

    • interaction: BaseInteraction<CacheType>

    Returns Promise<void>

handleInteraction

hasAccessToUserComponent

initialize

load

matchComponentOriginConstraints

matchConstraints

  • matchConstraints(interaction, client, cmdContext): Promise<boolean>

  • Make sure the command matches all constraints - things like required Discord permissions, internal permissions, NSFW channels, etc.

    Parameters

    Returns Promise<boolean>

    True if the command matches all constraints (should execute), false otherwise

matchDMConstraints

matchDiscordPermConstraints

  • matchDiscordPermConstraints(interaction, client, targetMember, perms): boolean

  • Parameters

    • interaction: I
    • client: Client<boolean>
    • targetMember: GuildMember | APIInteractionGuildMember
    • perms: PermissionsBitField[]

    Returns boolean

matchEnabledConstraints

matchNSFWConstraints

matchPermLevelConstraints

matchPermissionConstraints

registerLocalizations

reply

  • reply(interaction, content, options?): Promise<null | Message<boolean>>

  • Convenience method to reply to an interaction and set ephemeral state dynamically - it's nice not having to boilerplate import everywhere

    Parameters

    Returns Promise<null | Message<boolean>>

resolveDescriptionLocalizations

resolveLocalizations

  • resolveLocalizations(cmdName, cmdLocalizationKey): any

  • Parameters

    • cmdName: string
    • cmdLocalizationKey: "name" | "description"

    Returns any

resolveNameLocalizations

throttleUsage

  • throttleUsage(interaction, client): boolean

  • Throttle command usage, make sure we don't exceed the command's configured cooldown

    Parameters

    • interaction: I
    • client: Client<boolean>

    Returns boolean

    Wether or not the command is on cooldown for this interaction

unInitialize

Settings

Member Visibility

Theme

On This Page

constructor_initializedaliasOfaliasescategoryclientclientPermscollectioncooldowndatadeferReplydisabledguildOnlyisEphemeralmanagermiddlewarensfwpermLevelrequiredResourceIdsrunsourceFilesourceFileStackTracesourceHashuserPermsinitializeddeferReplyInternalhandleInteractionhasAccessToUserComponentinitializeloadmatchComponentOriginConstraintsmatchConstraintsmatchDMConstraintsmatchDiscordPermConstraintsmatchEnabledConstraintsmatchNSFWConstraintsmatchPermLevelConstraintsmatchPermissionConstraintsregisterLocalizationsreplyresolveDescriptionLocalizationsresolveLocalizationsresolveNameLocalizationsthrottleUsageunInitialize