Class SelectMenuOptionBuilder

constructor

• new SelectMenuOptionBuilder(
      data?: Partial<APISelectMenuOption>,
  ): SelectMenuOptionBuilder

  Creates a new string select menu option from API data.

  Parameters

  • Optionaldata: Partial<APISelectMenuOption>

    The API data to create this string select menu option with

  Returns SelectMenuOptionBuilder

  Example

  Creating a string select menu option from an API data object:

  const selectMenuOption = new SelectMenuOptionBuilder({
  	label: 'catchy label',
  	value: '1',
  });
  Copy

  Example

  Creating a string select menu option using setters and API data:

  const selectMenuOption = new SelectMenuOptionBuilder({
  	default: true,
  	value: '1',
  })
  	.setLabel('woah');
  Copy

data

setDefault

• setDefault(isDefault?: boolean): this

  Sets whether this option is selected by default.

  Parameters

  • OptionalisDefault: boolean

    Whether this option is selected by default

  Returns this

setDescription

• setDescription(description: string): this

  Sets the description for this option.

  Parameters

  • description: string

    The description to use

  Returns this

setEmoji

• setEmoji(emoji: APIMessageComponentEmoji): this

  Sets the emoji to display for this option.

  Parameters

  • emoji: APIMessageComponentEmoji

    The emoji to use

  Returns this

setLabel

• setLabel(label: string): this

  Sets the label for this option.

  Parameters

  • label: string

    The label to use

  Returns this

setValue

• setValue(value: string): this

  Sets the value for this option.

  Parameters

  • value: string

    The value to use

  Returns this

toJSON

• toJSON(): APISelectMenuOption

  Serializes this builder to API-compatible JSON data.

  Returns APISelectMenuOption

  Remarks

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