class StringSelectMenuBuilder

export declare class StringSelectMenuBuilder extends BaseSelectMenuBuilder<APIStringSelectComponent>

A builder that creates API-compatible JSON data for string select menus.

Constructors

constructor(
data?: Partial<APIStringSelectComponent>
)

Creates a new select menu from API data.

protectedreadonly
data : StringSelectMenuData

readonly
options : readonly StringSelectMenuOptionBuilder[]

The options for this select menu.

addOptions(
...options: RestOrArray<APISelectMenuOption | StringSelectMenuOptionBuilder | ((builder: StringSelectMenuOptionBuilder) => StringSelectMenuOptionBuilder)>
) : this

Adds options to this select menu.

clearPlaceholder() : this

Clears the placeholder for this select menu.

Inherited from: BaseSelectMenuBuilder

setCustomId(
customId: string
) : this

Sets the custom id for this select menu.

Inherited from: BaseSelectMenuBuilder

setDisabled(
disabled?: boolean
) : this

Sets whether this select menu is disabled.

Inherited from: BaseSelectMenuBuilder

setMaxValues(
maxValues: number
) : this

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

Inherited from: BaseSelectMenuBuilder

setMinValues(
minValues: number
) : this

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

Inherited from: BaseSelectMenuBuilder

setOptions(
...options: RestOrArray<APISelectMenuOption | StringSelectMenuOptionBuilder | ((builder: StringSelectMenuOptionBuilder) => StringSelectMenuOptionBuilder)>
) : this

Sets the options for this select menu.

setPlaceholder(
placeholder: string
) : this

Sets the placeholder for this select menu.

Inherited from: BaseSelectMenuBuilder

spliceOptions(
index: number
deleteCount: number
...options: (APISelectMenuOption | StringSelectMenuOptionBuilder | ((builder: StringSelectMenuOptionBuilder) => StringSelectMenuOptionBuilder))[]
) : this

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

Examples:Remove the first option:
selectMenu.spliceOptions(0, 1);
Remove the first n option:
const n = 4;
selectMenu.spliceOptions(0, n);
Remove the last option:
selectMenu.spliceOptions(-1, 1);

toJSON(
validationOverride?: boolean
) : APIStringSelectComponent

Serializes this builder to API-compatible JSON data.Note that by disabling validation, there is no guarantee that the resulting object will be valid.