Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SelectMenuOptionBuilder

Represents a validated button component

Hierarchy

  • SelectMenuOptionBuilder

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

data

data: APISelectMenuOption

Accessors

default

  • get default(): undefined | boolean

  • Whether this option should be already-selected by default

    Returns undefined | boolean

description

  • get description(): undefined | string

  • An additional description of the option (max 50 chars)

    Returns undefined | string

emoji

  • The emoji to display to the left of the option

    Returns undefined | APIMessageComponentEmoji

label

  • get label(): string

  • The user-facing name of the option (max 25 chars)

    Returns string

value

  • get value(): string

  • The dev-defined value of the option (max 100 chars)

    Returns string

Methods

setDefault

  • Sets whether this option should be already-selected by default

    Parameters

    • defaultOption: boolean = true

    Returns SelectMenuOptionBuilder

setDescription

  • Sets the additional description of the option (max 50 chars)

    Parameters

    • Optional description: string

    Returns SelectMenuOptionBuilder

setEmoji

  • Sets the emoji to display to the left of the option

    example
    selectMenuOption.setEmoji('😱');
    example
    selectMenuOption.setEmoji('<:funny:957998724506857472>');

    Parameters

    Returns SelectMenuOptionBuilder

setLabel

  • Sets the user-facing name of the option (max 25 chars)

    Parameters

    • label: string

    Returns SelectMenuOptionBuilder

setValue

  • Sets the dev-defined value of the option (max 100 chars)

    Parameters

    • value: string

    Returns SelectMenuOptionBuilder

toJSON

  • Returns the raw data of this option

    Returns APISelectMenuOption

Generated using TypeDoc version 0.22.16, the 9/16/2022 at 1:09:15 AM