StringSelectMenuOptionBuilder

declare class StringSelectMenuOptionBuilder implements JSONEncodable<APISelectMenuOption>
declare class StringSelectMenuOptionBuilder implements JSONEncodable<APISelectMenuOption>
A builder that creates API-compatible JSON data for string select menu options.
constructor(data?)
Creates a new string select menu option from API data.
Example
Creating a string select menu option from an API data object:
const selectMenuOption = new SelectMenuOptionBuilder({
label: 'catchy label',
value: '1',
});
const selectMenuOption = new SelectMenuOptionBuilder({
label: 'catchy label',
value: '1',
});
Example
Creating a string select menu option using setters and API data:
const selectMenuOption = new SelectMenuOptionBuilder({
default: true,
value: '1',
})
.setLabel('woah');
const selectMenuOption = new SelectMenuOptionBuilder({
default: true,
value: '1',
})
.setLabel('woah');
NameTypeOptionalDescription
dataPartial<APISelectMenuOption>Yes
The API data to create this string select menu option with
setDefault(isDefault?):this
Sets whether this option is selected by default.
NameTypeOptionalDescription
isDefaultbooleanYes
Whether this option is selected by default
setDescription(description):this
Sets the description for this option.
NameTypeOptionalDescription
descriptionstringNo
The description to use
setEmoji(emoji):this
Sets the emoji to display for this option.
NameTypeOptionalDescription
emojiAPIMessageComponentEmojiNo
The emoji to use
setLabel(label):this
Sets the label for this option.
NameTypeOptionalDescription
labelstringNo
The label to use
setValue(value):this
Sets the value for this option.
NameTypeOptionalDescription
valuestringNo
The value to use
Serializes this builder to API-compatible JSON data.
Remarks
This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.