Class Command

constructor

• new Command(): Command

  Returns Command

contexts

Optionaldefault_member_permissions

defaultLocale

Optionaldescription

Optionaldescription_localizations

Optionalname

Optionalname_localizations

nsfw

options

type

addOption

• addOption(option: CommandOptionBuilder): Command

  Adds an option to the command.

  Parameters

  • option: CommandOptionBuilder

    Adds an option to the command.

  Returns Command

setDefaultLocale

• setDefaultLocale(locale: Locale): Command

  Sets the default locale for localisation.

  Parameters

  • locale: Locale

    Sets the default locale for localisation.

  Returns Command

  See

  https://discord.com/developers/docs/reference#locales

setDefaultMemberPermissions

• setDefaultMemberPermissions(permissions: string): Command

  Sets the permission needed to use the command.

  Parameters

  • permissions: string

    The permissions required to be able to use this command.

  Returns Command

setDescription

• setDescription(description: string | CommandDescriptionLocalizations): Command

  Sets the description of the command.

  Parameters

  • description: string | CommandDescriptionLocalizations

    The description of the command, or an object of descriptions for localisation.

  Returns Command

  See

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

setName

• setName(name: string | CommandNameLocalizations): Command

  Sets the name of the command.

  Parameters

  • name: string | CommandNameLocalizations

    The name of the command or an object of names for localisation.

  Returns Command

  See

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

setNsfw

• setNsfw(nsfw: boolean): Command

  Sets whether this command is NSFW.

  Parameters

  • nsfw: boolean

    Whether this command is NSFW.

  Returns Command

setType

• setType(type: ApplicationCommandType): Command

  Sets the command type.

  Parameters

  • type: ApplicationCommandType

    The command type.

  Returns Command

  See

  https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-types

toJSON

• toJSON(
      format?: JsonTypes,
      __namedParameters?: { suppressValidation: boolean },
  ): {
      default_member_permissions: undefined | string;
      description: undefined | string;
      description_localizations: undefined | CommandDescriptionLocalizations;
      name: undefined | string;
      name_localizations: undefined | CommandNameLocalizations;
      nsfw: boolean;
      options: (
          | CommandOptionStorageJSON
          | CommandOptionCacheJSON
          | CommandOptionDiscordJSON
      )[];
      type: ApplicationCommandType;
  }

  Returns the correct Discord format for a command.

  Parameters

  • Optionalformat: JsonTypes
  • __namedParameters: { suppressValidation: boolean } = ...

  Returns {
      default_member_permissions: undefined | string;
      description: undefined | string;
      description_localizations: undefined | CommandDescriptionLocalizations;
      name: undefined | string;
      name_localizations: undefined | CommandNameLocalizations;
      nsfw: boolean;
      options: (
          | CommandOptionStorageJSON
          | CommandOptionCacheJSON
          | CommandOptionDiscordJSON
      )[];
      type: ApplicationCommandType;
  }