Class CommandOption

constructor

• new CommandOption(): CommandOption

  Creates an option for a command.

  Returns CommandOption

autocomplete

Optionalchannel_types

choices

defaultLocale

Optionaldescription

Optionaldescription_localizations

Optionalmax_length

Optionalmax_value

Optionalmin_length

Optionalmin_value

Optionalname

Optionalname_localizations

options

Optionalrequired

Optionaltype

addChoice

• addChoice(choice: CommandChoiceBuilder): CommandOption

  Adds a choice to the option.

  Parameters

  • choice: CommandChoiceBuilder

    Adds a choice to the option.

  Returns CommandOption

addOption

• addOption(option: CommandOptionBuilder): CommandOption

  Adds an option to this option.

  Parameters

  • option: CommandOptionBuilder

    Adds an option to this option.

  Returns CommandOption

setAutocomplete

• setAutocomplete(autocomplete: boolean): CommandOption

  Sets whether autocomplete is enabled for this option.

  Parameters

  • autocomplete: boolean

    Whether autocomplete is enabled for this option.

  Returns CommandOption

setChannelTypes

• setChannelTypes(channelTypes: ChannelType[]): CommandOption

  Sets which channel types are selectable by the user.

  Parameters

  • channelTypes: ChannelType[]

    An array of channel types to offer as a choice.

  Returns CommandOption

  See

  https://discord.com/developers/docs/resources/channel#channel-object-channel-types

setDefaultLocale

• setDefaultLocale(locale: Locale): CommandOption

  Sets the default locale for localisation.

  Parameters

  • locale: Locale

    Sets the default locale for localisation.

  Returns CommandOption

  See

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

setDescription

• setDescription(
      description: string | CommandOptionDescriptionLocalizations,
  ): CommandOption

  Sets the description of the command choice.

  Parameters

  • description: string | CommandOptionDescriptionLocalizations

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

  Returns CommandOption

  See

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

setMaxLength

• setMaxLength(length: number): CommandOption

  Sets the maximum length the user may enter.

  Parameters

  • length: number

    The maximum length that the user may enter.

  Returns CommandOption

setMaxValue

• setMaxValue(value: number): CommandOption

  Sets the maximum value the user may enter.

  Parameters

  • value: number

    The maximum number value that the user may enter.

  Returns CommandOption

setMinLength

• setMinLength(length: number): CommandOption

  Sets the minimum length the user may enter.

  Parameters

  • length: number

    The minimum length that the user may enter.

  Returns CommandOption

setMinValue

• setMinValue(value: number): CommandOption

  Sets the minimum value the user may enter.

  Parameters

  • value: number

    The minimum number value that the user may enter.

  Returns CommandOption

setName

• setName(name: string | CommandOptionNameLocalizations): CommandOption

  Sets the name of the option.

  Parameters

  • name: string | CommandOptionNameLocalizations

    Sets the name of the option, or an object of names for localisation.

  Returns CommandOption

setRequired

• setRequired(isRequired: boolean): CommandOption

  Sets whether the option is required.

  Parameters

  • isRequired: boolean

    Whether the option is required.

  Returns CommandOption

setType

• setType(type: ApplicationCommandOptionType): CommandOption

  Sets the option type.

  Parameters

  • type: ApplicationCommandOptionType

    The option type.

  Returns CommandOption

  See

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

toJSON

• toJSON(
      format?: JsonTypes,
      __namedParameters?: { suppressValidation: boolean },
  ): {
      autocomplete: boolean;
      channel_types: undefined | ChannelType[];
      choices: (
          | CommandChoiceBuilderStorageJSON
          | CommandChoiceBuilderDiscordJSON
          | CommandChoiceBuilderCacheJSON
      )[];
      description: string;
      description_localizations: | undefined
      | CommandOptionDescriptionLocalizations;
      max_length: undefined
      | number;
      max_value: undefined | number;
      min_length: undefined | number;
      min_value: undefined | number;
      name: string;
      name_localizations: undefined | CommandOptionNameLocalizations;
      options: (
          | CommandOptionStorageJSON
          | CommandOptionCacheJSON
          | CommandOptionDiscordJSON
      )[];
      required: undefined
      | boolean;
      type: ApplicationCommandOptionType;
  }

  Returns the correct Discord format for a command option.

  Parameters

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

  Returns {
      autocomplete: boolean;
      channel_types: undefined | ChannelType[];
      choices: (
          | CommandChoiceBuilderStorageJSON
          | CommandChoiceBuilderDiscordJSON
          | CommandChoiceBuilderCacheJSON
      )[];
      description: string;
      description_localizations: | undefined
      | CommandOptionDescriptionLocalizations;
      max_length: undefined
      | number;
      max_value: undefined | number;
      min_length: undefined | number;
      min_value: undefined | number;
      name: string;
      name_localizations: undefined | CommandOptionNameLocalizations;
      options: (
          | CommandOptionStorageJSON
          | CommandOptionCacheJSON
          | CommandOptionDiscordJSON
      )[];
      required: undefined
      | boolean;
      type: ApplicationCommandOptionType;
  }