discord.js | StringSelectMenuOptionBuilder

Search...

StringSelectMenuOptionBuilder

export declare class StringSelectMenuOptionBuilder implements JSONEncodable<APISelectMenuOption>

export declare class StringSelectMenuOptionBuilder implements JSONEncodable<APISelectMenuOption>

Represents an option within a string select menu component

constructor(data?)

Creates a new string select menu option from API data

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',
});

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')

Name	Type	Optional	Description
data	Partial<APISelectMenuOption>	Yes	The API data to create this string select menu option with

setDefault(isDefault?):this

Sets whether this option is selected by default

Name	Type	Optional	Description
isDefault	boolean	Yes	Whether this option is selected by default

setDescription(description):this

Sets the description of this option

Name	Type	Optional	Description
description	string	No	The description of this option

setEmoji(emoji):this

Sets the emoji to display on this option

Name	Type	Optional	Description
emoji	APIMessageComponentEmoji	No	The emoji to display on this option

setLabel(label):this

Sets the label of this option

Name	Type	Optional	Description
label	string	No	The label to show on this option

setValue(value):this

Sets the value of this option

Name	Type	Optional	Description
value	string	No	The value of this option

Serializes this component to an API-compatible JSON object

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