Class Command<T>

Type Parameters

  • T = unknown

Hierarchy

  • SlashCommandBuilder
    • Command

Constructors

constructor

Properties

default_member_permissions default_permission description description_localizations? dm_permission handler name name_localizations? options

Methods

addAttachmentOption addBooleanOption addChannelOption addIntegerOption addMentionableOption addNumberOption addRoleOption addStringOption addSubcommand addSubcommandGroup addUserOption handle match setDMPermission setDefaultMemberPermissions setDefaultPermission setDescription setDescriptionLocalization setDescriptionLocalizations setName setNameLocalization setNameLocalizations toJSON

Constructors

constructor

  • Type Parameters

    • T = unknown

    Parameters

    • name: string
    • description: string

    Returns Command<T>

Properties

Readonly default_member_permissions

default_member_permissions: undefined | null | string

Set of permissions represented as a bit set for the command

Readonly default_permission

default_permission: undefined | boolean

Whether the command is enabled by default when the app is added to a guild

Deprecated

This property is deprecated and will be removed in the future. You should use setDefaultMemberPermissions or setDMPermission instead.

Readonly description

description: string

The description of this slash command

Optional Readonly description_localizations

description_localizations?: Partial<Record<"en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

The localized descriptions for this command

Readonly dm_permission

dm_permission: undefined | boolean

Indicates whether the command is available in DMs with the application, only for globally-scoped commands. By default, commands are visible.

handler

handler: Handler<T> = ...

Readonly name

name: string

The name of this slash command

Optional Readonly name_localizations

name_localizations?: Partial<Record<"en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

The localized names for this command

Readonly options

options: ToAPIApplicationCommandOptions[]

The options of this slash command

Methods

addAttachmentOption

  • Adds an attachment option

    Parameters

    • input: SlashCommandAttachmentOption | ((builder: SlashCommandAttachmentOption) => SlashCommandAttachmentOption)

      A function that returns an option builder, or an already built builder

    Returns Omit<Command<T>, "addSubcommand" | "addSubcommandGroup">

addBooleanOption

  • Adds a boolean option

    Parameters

    • input: SlashCommandBooleanOption | ((builder: SlashCommandBooleanOption) => SlashCommandBooleanOption)

      A function that returns an option builder, or an already built builder

    Returns Omit<Command<T>, "addSubcommand" | "addSubcommandGroup">

addChannelOption

  • Adds a channel option

    Parameters

    • input: SlashCommandChannelOption | ((builder: SlashCommandChannelOption) => SlashCommandChannelOption)

      A function that returns an option builder, or an already built builder

    Returns Omit<Command<T>, "addSubcommand" | "addSubcommandGroup">

addIntegerOption

  • Adds an integer option

    Parameters

    • input: SlashCommandIntegerOption | Omit<SlashCommandIntegerOption, "setAutocomplete"> | Omit<SlashCommandIntegerOption, "addChoices"> | ((builder: SlashCommandIntegerOption) => SlashCommandIntegerOption | Omit<SlashCommandIntegerOption, "setAutocomplete"> | Omit<SlashCommandIntegerOption, "addChoices">)

      A function that returns an option builder, or an already built builder

    Returns Omit<Command<T>, "addSubcommand" | "addSubcommandGroup">

addMentionableOption

  • Adds a mentionable option

    Parameters

    • input: SlashCommandMentionableOption | ((builder: SlashCommandMentionableOption) => SlashCommandMentionableOption)

      A function that returns an option builder, or an already built builder

    Returns Omit<Command<T>, "addSubcommand" | "addSubcommandGroup">

addNumberOption

  • Adds a number option

    Parameters

    • input: SlashCommandNumberOption | Omit<SlashCommandNumberOption, "setAutocomplete"> | Omit<SlashCommandNumberOption, "addChoices"> | ((builder: SlashCommandNumberOption) => SlashCommandNumberOption | Omit<SlashCommandNumberOption, "setAutocomplete"> | Omit<SlashCommandNumberOption, "addChoices">)

      A function that returns an option builder, or an already built builder

    Returns Omit<Command<T>, "addSubcommand" | "addSubcommandGroup">

addRoleOption

  • Adds a role option

    Parameters

    • input: SlashCommandRoleOption | ((builder: SlashCommandRoleOption) => SlashCommandRoleOption)

      A function that returns an option builder, or an already built builder

    Returns Omit<Command<T>, "addSubcommand" | "addSubcommandGroup">

addStringOption

  • Adds a string option

    Parameters

    • input: SlashCommandStringOption | Omit<SlashCommandStringOption, "setAutocomplete"> | Omit<SlashCommandStringOption, "addChoices"> | ((builder: SlashCommandStringOption) => SlashCommandStringOption | Omit<SlashCommandStringOption, "setAutocomplete"> | Omit<SlashCommandStringOption, "addChoices">)

      A function that returns an option builder, or an already built builder

    Returns Omit<Command<T>, "addSubcommand" | "addSubcommandGroup">

addSubcommand

  • Adds a new subcommand to this command

    Parameters

    • input: SlashCommandSubcommandBuilder | ((subcommandGroup: SlashCommandSubcommandBuilder) => SlashCommandSubcommandBuilder)

      A function that returns a subcommand builder, or an already built builder

    Returns SlashCommandSubcommandsOnlyBuilder

addSubcommandGroup

  • Adds a new subcommand group to this command

    Parameters

    • input: SlashCommandSubcommandGroupBuilder | ((subcommandGroup: SlashCommandSubcommandGroupBuilder) => SlashCommandSubcommandGroupBuilder)

      A function that returns a subcommand group builder, or an already built builder

    Returns SlashCommandSubcommandsOnlyBuilder

addUserOption

  • Adds a user option

    Parameters

    • input: SlashCommandUserOption | ((builder: SlashCommandUserOption) => SlashCommandUserOption)

      A function that returns an option builder, or an already built builder

    Returns Omit<Command<T>, "addSubcommand" | "addSubcommandGroup">

handle

match

  • Parameters

    • interaction: CommandInteraction<CacheType>

    Returns boolean

setDMPermission

  • Sets if the command is available in DMs with the application, only for globally-scoped commands. By default, commands are visible.

    See

    https://discord.com/developers/docs/interactions/application-commands#permissions

    Parameters

    • enabled: undefined | null | boolean

      If the command should be enabled in DMs

    Returns Command<T>

setDefaultMemberPermissions

  • Sets the default permissions a member should have in order to run the command.

    Note: You can set this to '0' to disable the command by default.

    See

    https://discord.com/developers/docs/interactions/application-commands#permissions

    Parameters

    • permissions: undefined | null | string | number | bigint

      The permissions bit field to set

    Returns Command<T>

setDefaultPermission

  • Sets whether the command is enabled by default when the application is added to a guild.

    Note: If set to false, you will have to later PUT the permissions for this command.

    See

    https://discord.com/developers/docs/interactions/application-commands#permissions

    Deprecated

    Use setDefaultMemberPermissions or setDMPermission instead.

    Parameters

    • value: boolean

      Whether or not to enable this command by default

    Returns Command<T>

setDescription

  • Sets the description

    Parameters

    • description: string

      The description

    Returns Command<T>

setDescriptionLocalization

  • Sets a description localization

    Parameters

    • locale: "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "sv-SE" | "th" | "tr" | "uk" | "vi"

      The locale to set a description for

    • localizedDescription: null | string

      The localized description for the given locale

    Returns Command<T>

setDescriptionLocalizations

  • Sets the description localizations

    Parameters

    • localizedDescriptions: null | Partial<Record<"en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

      The dictionary of localized descriptions to set

    Returns Command<T>

setName

  • Sets the name

    Parameters

    • name: string

      The name

    Returns Command<T>

setNameLocalization

  • Sets a name localization

    Parameters

    • locale: "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "sv-SE" | "th" | "tr" | "uk" | "vi"

      The locale to set a description for

    • localizedName: null | string

      The localized description for the given locale

    Returns Command<T>

setNameLocalizations

  • Sets the name localizations

    Parameters

    • localizedNames: null | Partial<Record<"en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

      The dictionary of localized descriptions to set

    Returns Command<T>

toJSON

  • Returns the final data that should be sent to Discord.

    Note: Calling this function will validate required properties based on their conditions.

    Returns RESTPostAPIApplicationCommandsJSONBody

Settings

Member Visibility

Theme

Generated using TypeDoc