Class ApplicationCommandOptionBuilder<T>

constructor

• new ApplicationCommandOptionBuilder<T>(type, name): ApplicationCommandOptionBuilder<T>

• Type Parameters

  • T extends ApplicationCommandOptionTypes = ApplicationCommandOptionTypes

  Parameters

  • type: T

  • name: string

  Returns ApplicationCommandOptionBuilder<T>

Optional autocomplete

Optional channelTypes

choices

description

Optional descriptionLocalizations

Optional max

Optional min

name

Optional nameLocalizations

options

Optional parent

Optional required

type

addChoice

• addChoice(name, value, nameLocalizations?): ApplicationCommandOptionBuilder<T>

• Add a choice.

  Parameters

  • name: string

    The name of the choice.

  • value: string | number

    The value of the choice.

  • Optional nameLocalizations: Record<string, string>

    A map of locales to name localizations.

  Returns ApplicationCommandOptionBuilder<T>

addDescriptionLocalization

• addDescriptionLocalization(locale, description): ApplicationCommandOptionBuilder<T>

• Add a description localization.

  Parameters

  • locale: string

    The locale of the localization.

  • description: string

    The localized description.

  Returns ApplicationCommandOptionBuilder<T>

addNameLocalization

• addNameLocalization(locale, name): ApplicationCommandOptionBuilder<T>

• Add a name localization.

  Parameters

  • locale: string

    The locale of the localization.

  • name: string

    The localized name.

  Returns ApplicationCommandOptionBuilder<T>

addOption

• addOption<O>(option): ApplicationCommandOptionBuilder<T>

• Add an option.

  Type Parameters

  • O extends ApplicationCommandOptionTypes = ApplicationCommandOptionTypes

  Parameters

  • option: ApplicationCommandOptions | ApplicationCommandOptionBuilder<O>

  Returns ApplicationCommandOptionBuilder<T>

• addOption<O>(name, type, extra?): ApplicationCommandOptionBuilder<T>

• Type Parameters

  • O extends ApplicationCommandOptionTypes = ApplicationCommandOptionTypes

  Parameters

  • name: string

  • type: O

  • Optional extra: ApplicationCommandOptions | ((this, option) => void)

  Returns ApplicationCommandOptionBuilder<T>

setAutocomplete

• setAutocomplete(value?): ApplicationCommandOptionBuilder<T>

• Toggle autocomplete for this option.

  Parameters

  • Optional value: boolean

  Returns ApplicationCommandOptionBuilder<T>

setChannelTypes

• setChannelTypes(types): ApplicationCommandOptionBuilder<T>

• Set the allowed channel types for this option.

  Parameters

  • types: ChannelTypes[]

  Returns ApplicationCommandOptionBuilder<T>

setChoices

• setChoices(choices): ApplicationCommandOptionBuilder<T>

• Set the choices for this option.

  Parameters

  • choices: ApplicationCommandOptionsChoice<ApplicationCommandOptionsTypesWithChoices>[]

  Returns ApplicationCommandOptionBuilder<T>

setDescription

• setDescription(description): ApplicationCommandOptionBuilder<T>

• Set the description of this option.

  Parameters

  • description: string

  Returns ApplicationCommandOptionBuilder<T>

setDescriptionLocalizations

• setDescriptionLocalizations(localizations): ApplicationCommandOptionBuilder<T>

• Set the description localizations of this option.

  Parameters

  • localizations: Record<string, string>

    A map of locales to localized description strings.

  Returns ApplicationCommandOptionBuilder<T>

setMinMax

• setMinMax(min?, max?): ApplicationCommandOptionBuilder<T>

• Set the min/max for this option. This applied to both minValue/maxValue and minLength/maxLength.

  Parameters

  • Optional min: number

  • Optional max: number

  Returns ApplicationCommandOptionBuilder<T>

setName

• setName(name): ApplicationCommandOptionBuilder<T>

• Set the name of this option.

  Parameters

  • name: string

  Returns ApplicationCommandOptionBuilder<T>

setNameLocalizations

• setNameLocalizations(localizations): ApplicationCommandOptionBuilder<T>

• Set the name localizations of this option.

  Parameters

  • localizations: Record<string, string>

    A map of locales to localized name strings.

  Returns ApplicationCommandOptionBuilder<T>

setRequired

• setRequired(value?): ApplicationCommandOptionBuilder<T>

• Toggle this option being required.

  Parameters

  • Optional value: boolean

  Returns ApplicationCommandOptionBuilder<T>

toJSON

• toJSON(): TypeToOption<T>

• Convert this command to JSON.

  Returns TypeToOption<T>