StringSelectOption

Represents an individual option for a string select menu.

Example

1
const option = new StringSelectOption().setLabel("Option 1").setValue("option_1");

Constructors

new StringSelectOption(data)

1
new StringSelectOption(data: Partial<APISelectMenuOption>): StringSelectOption

Parameters

Parameter	Type
`data`	`Partial`<`APISelectMenuOption`>

Returns

StringSelectOption

Source

seyfert/src/builders/SelectMenu.ts:322

Properties

Property	Modifier	Type
`data`	`public`	`Partial`<`APISelectMenuOption`>

Methods

setDefault()

1
setDefault(Default: boolean): this

Sets whether the option is the default. [Default=true] - Indicates whether the option is the default.

Parameters

Parameter	Type	Default value
`Default`	`boolean`	`true`

Returns

this

The current StringSelectOption instance.

Source

seyfert/src/builders/SelectMenu.ts:359

setDescription()

1
setDescription(description: string): this

Sets the description for the option. description - The description for the option.

Parameters

Parameter	Type
`description`	`string`

Returns

this

The current StringSelectOption instance.

Source

seyfert/src/builders/SelectMenu.ts:349

setEmoji()

1
setEmoji(emoji: EmojiResolvable): StringSelectOption

Sets the emoji for the option.

Parameters

Parameter	Type	Description
`emoji`	`EmojiResolvable`	The emoji to set.

Returns

StringSelectOption

The modified option instance.

Source

seyfert/src/builders/SelectMenu.ts:369

setLabel()

1
setLabel(label: string): this

Sets the label for the option. label - The label for the option.

Parameters

Parameter	Type
`label`	`string`

Returns

this

The current StringSelectOption instance.

Source

seyfert/src/builders/SelectMenu.ts:329

setValue()

1
setValue(value: string): this

Sets the value for the option. value - The value for the option.

Parameters

Parameter	Type
`value`	`string`

Returns

this

The current StringSelectOption instance.

Source

seyfert/src/builders/SelectMenu.ts:339

toJSON()

1
toJSON(): APISelectMenuOption

Converts the option to JSON format.

Returns

APISelectMenuOption

The option data in JSON format.

Source

seyfert/src/builders/SelectMenu.ts:380