Class ComponentBuilder<T>

constructor

• new ComponentBuilder<T>(rowMax?): ComponentBuilder<T>

• Type Parameters

  • T extends MessageActionRow | ModalActionRow = MessageActionRow | ModalActionRow

  Parameters

  • Optional rowMax: RowMax

  Returns ComponentBuilder<T>

rowMax

addComponent

• addComponent(component): ComponentBuilder<T>

• Add a component to the current row, or a new row depending on certain conditions

  Parameters

  • component: ValidComponents

    The component to add.

  Returns ComponentBuilder<T>

addComponents

• addComponents(...components): ComponentBuilder<T>

• Add several components.

  Parameters

  • Rest ...components: ValidComponents[]

    The components to add.

  Returns ComponentBuilder<T>

addInteractionButton

• addInteractionButton(options): ComponentBuilder<T>

• Add an interaction button to the current row.

  Parameters

  • options: AddInteractionButtonOptions

    The options for adding the interaction button.

  Returns ComponentBuilder<T>

addRow

• addRow(components?): ComponentBuilder<T>

• Start a new action row.

  Parameters

  • Optional components: ValidComponents[]

    The components to start this new row with.

  Returns ComponentBuilder<T>

addSelectMenu

• addSelectMenu(options): ComponentBuilder<T>

• Add a select menu (to the current row, if empty - else as a new row).

  Parameters

  • options: AddSelectMenuOptions

    The options for adding the select menu.

  Returns ComponentBuilder<T>

addTextInput

• addTextInput(options): ComponentBuilder<T>

• Add a text input to the current row.

  Parameters

  • options: AddTextMenuOptions

    The options for adding the text input.

  Returns ComponentBuilder<T>

addURLButton

• addURLButton(options): ComponentBuilder<T>

• Add a url button to the current row

  Parameters

  • options: AddURLButtonOptions

    The options for adding the url button.

  Returns ComponentBuilder<T>

removeEmptyRows

• removeEmptyRows(): ComponentBuilder<T>

• Remove all of the rows that are empty.

  Returns ComponentBuilder<T>

setRowMax

• setRowMax(rowMax): ComponentBuilder<T>

• Parameters

  • rowMax: RowMax

  Returns ComponentBuilder<T>

toJSON

• toJSON(): T[]

• convert the current contents to JSON

  Returns T[]

toJSONRaw

• toJSONRaw(): ToRaw<T>[]

• convert the current contents to JSON

  Returns ToRaw<T>[]

Static emojiToPartial

• emojiToPartial(emoji, type?): PartialEmoji

• Convert an emoji to a partial.

  Example

  emojiToPartial("🐾", "default")
  Copy

  Example

  emojiToPartial("<:paws8:681748079778463796>", "custom")
  Copy

  Parameters

  • emoji: string

    The unicode point of the emoji if default, else the fully qualified emoji.

  • Optional type: "default" | "custom"

    default if built in (unicode), custom otherwise (this can be assumed from the format by us).

  Returns PartialEmoji