Class StringSelectMenuBuilder

Readonlydata

Readonlyoptions

addOptions

• addOptions(...options): this

• Adds options to this select menu.

  Parameters

  • Rest...options: RestOrArray<SelectMenuComponentOptionData | StringSelectMenuOptionBuilder | APISelectMenuOption>

    The options to add

  Returns this

setDisabled

• setDisabled(disabled?): this

• Sets whether this select menu is disabled.

  Parameters

  • Optionaldisabled: boolean

    Whether this select menu is disabled

  Returns this

setMaxValues

• setMaxValues(maxValues): this

• Sets the maximum values that must be selected in the select menu.

  Parameters

  • maxValues: number

    The maximum values that must be selected

  Returns this

setMinValues

• setMinValues(minValues): this

• Sets the minimum values that must be selected in the select menu.

  Parameters

  • minValues: number

    The minimum values that must be selected

  Returns this

setOptions

• setOptions(...options): this

• Sets the options for this select menu.

  Parameters

  • Rest...options: RestOrArray<SelectMenuComponentOptionData | StringSelectMenuOptionBuilder | APISelectMenuOption>

    The options to set

  Returns this

setPlaceholder

• setPlaceholder(placeholder): this

• Sets the placeholder for this select menu.

  Parameters

  • placeholder: string

    The placeholder to use

  Returns this

spliceOptions

• spliceOptions(index, deleteCount, ...options): this

• Removes, replaces, or inserts options for this select menu.

  Parameters

  • index: number

    The index to start at
  • deleteCount: number

    The number of options to remove
  • Rest...options: RestOrArray<StringSelectMenuOptionBuilder | APISelectMenuOption>

    The replacing option objects or builders

  Returns this

  Remarks

  This method behaves similarly to Array.prototype.splice(). It's useful for modifying and adjusting the order of existing options.

  Example

  Remove the first option:

  selectMenu.spliceOptions(0, 1);
  Copy

  Example

  Remove the first n option:

  const n = 4;
  selectMenu.spliceOptions(0, n);
  Copy

  Example

  Remove the last option:

  selectMenu.spliceOptions(-1, 1);
  Copy

toJSON

• toJSON(): APIStringSelectComponent

• {@inheritDoc BaseSelectMenuBuilder.toJSON}

  Returns APIStringSelectComponent

Staticfrom

• from(other): StringSelectMenuBuilder

• Parameters

  • other: APIStringSelectComponent | JSONEncodable<APIStringSelectComponent>

  Returns StringSelectMenuBuilder