Class SelectMenuBuilder

constructor

• new SelectMenuBuilder(
      data?: Partial<APIStringSelectComponent>,
  ): SelectMenuBuilder

  Creates a new select menu from API data.

  Parameters

  • Optionaldata: Partial<APIStringSelectComponent>

    The API data to create this select menu with

  Returns SelectMenuBuilder

  Example

  Creating a select menu from an API data object:

  const selectMenu = new StringSelectMenuBuilder({
  	custom_id: 'a cool select menu',
  	placeholder: 'select an option',
  	max_values: 2,
  	options: [
  		{ label: 'option 1', value: '1' },
  		{ label: 'option 2', value: '2' },
  		{ label: 'option 3', value: '3' },
  	],
  });
  Copy

  Example

  Creating a select menu using setters and API data:

  const selectMenu = new StringSelectMenuBuilder({
  	custom_id: 'a cool select menu',
  })
  	.setMinValues(1)
  	.addOptions({
  		label: 'Catchy',
  		value: 'catch',
  	});
  Copy

Readonlyoptions

addOptions

• addOptions(
      ...options: RestOrArray<APISelectMenuOption | SelectMenuOptionBuilder>,
  ): this

  Adds options to this select menu.

  Parameters

  • ...options: RestOrArray<APISelectMenuOption | SelectMenuOptionBuilder>

    The options to add

  Returns this

setOptions

• setOptions(
      ...options: RestOrArray<APISelectMenuOption | SelectMenuOptionBuilder>,
  ): this

  Sets the options for this select menu.

  Parameters

  • ...options: RestOrArray<APISelectMenuOption | SelectMenuOptionBuilder>

    The options to set

  Returns this

spliceOptions

• spliceOptions(
      index: number,
      deleteCount: number,
      ...options: RestOrArray<APISelectMenuOption | SelectMenuOptionBuilder>,
  ): 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

  • ...options: RestOrArray<APISelectMenuOption | SelectMenuOptionBuilder>

    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

  Serializes this builder to API-compatible JSON data.

  Returns APIStringSelectComponent

  Remarks

  This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.