class StringSelectMenuBuilder

export class StringSelectMenuBuilder extends BuilderStringSelectMenuComponent

Class used to build select menu components to be sent through the API

Constructors

constructor(
data?: Partial<StringSelectMenuComponentData | APIStringSelectComponent>
)

Constructs a new instance of the StringSelectMenuBuilder class

readonlyexternal
data : Partial<SelectMenuType>

The API data associated with this component.

Inherited from: ComponentBuilder

readonlyexternal
options : StringSelectMenuOptionBuilder[]

The options within this select menu.

Inherited from: SelectMenuBuilder

addOptions(
...options: RestOrArray<BuildersSelectMenuOption | SelectMenuComponentOptionData | APISelectMenuOption>
) : this

Adds options to this select menu

static
from(
other: JSONEncodable<APIStringSelectComponent> | APIStringSelectComponent
) : StringSelectMenuBuilder

Creates a new select menu builder from json data

external
setCustomId(
customId: string
) : this

Sets the custom id for this select menu.

Inherited from: BaseSelectMenuBuilder

external
setDisabled(
disabled?: boolean
) : this

Sets whether this select menu is disabled.

Inherited from: BaseSelectMenuBuilder

external
setMaxValues(
maxValues: number
) : this

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

Inherited from: BaseSelectMenuBuilder

external
setMinValues(
minValues: number
) : this

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

Inherited from: BaseSelectMenuBuilder

setOptions(
...options: RestOrArray<BuildersSelectMenuOption | SelectMenuComponentOptionData | APISelectMenuOption>
) : this

Sets the options on this select menu

external
setPlaceholder(
placeholder: string
) : this

Sets the placeholder for this select menu.

Inherited from: BaseSelectMenuBuilder

external
spliceOptions(
index: number
deleteCount: number
...options: RestOrArray<APISelectMenuOption | 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);

Inherited from: SelectMenuBuilder

external
toJSON() : APIStringSelectComponent

Serializes this builder to API-compatible JSON data.

Inherited from: SelectMenuBuilder