Class SectionBuilder

constructor

• new SectionBuilder(data?: Partial<APISectionComponent>): SectionBuilder

  Creates a new section from API data.

  Parameters

  • Optionaldata: Partial<APISectionComponent>

    The API data to create this section with

  Returns SectionBuilder

  Example

  Creating a section from an API data object:

  const section = new SectionBuilder({
  	components: [
  		{
  			content: "Some text here",
  			type: ComponentType.TextDisplay,
  		},
  	],
   accessory: {
       media: {
           url: 'https://cdn.discordapp.com/embed/avatars/3.png',
       },
   }
  });
  Copy

  Example

  Creating a section using setters and API data:

  const section = new SectionBuilder({
  	components: [
  		{
  			content: "# Heading",
  			type: ComponentType.TextDisplay,
  		},
  	],
  })
  	.setPrimaryButtonAccessory(button);
  Copy

Optional Readonlyaccessory

Readonlycomponents

addTextDisplayComponents

• addTextDisplayComponents(
      ...components: RestOrArray<
          | TextDisplayBuilder
          | ((builder: TextDisplayBuilder) => TextDisplayBuilder),
      >,
  ): this

  Adds text display components to this section.

  Parameters

  • ...components: RestOrArray<
        | TextDisplayBuilder
        | ((builder: TextDisplayBuilder) => TextDisplayBuilder),
    >

    The text display components to add

  Returns this

setButtonAccessory

• setButtonAccessory(
      accessory:
          | APIButtonComponent
          | ButtonBuilder
          | ((builder: ButtonBuilder) => ButtonBuilder),
  ): this

  Sets the accessory of this section to a button.

  Parameters

  • accessory: APIButtonComponent | ButtonBuilder | ((builder: ButtonBuilder) => ButtonBuilder)

    The accessory to use

  Returns this

setThumbnailAccessory

• setThumbnailAccessory(
      accessory:
          | APIThumbnailComponent
          | ThumbnailBuilder
          | ((builder: ThumbnailBuilder) => ThumbnailBuilder),
  ): this

  Sets the accessory of this section to a thumbnail.

  Parameters

  • accessory:
        | APIThumbnailComponent
        | ThumbnailBuilder
        | ((builder: ThumbnailBuilder) => ThumbnailBuilder)

    The accessory to use

  Returns this

spliceTextDisplayComponents

• spliceTextDisplayComponents(
      index: number,
      deleteCount: number,
      ...components: RestOrArray<
          | APITextDisplayComponent
          | TextDisplayBuilder
          | ((builder: TextDisplayBuilder) => TextDisplayBuilder),
      >,
  ): this

  Removes, replaces, or inserts text display components for this section.

  Parameters

  • index: number

    The index to start removing, replacing or inserting text display components

  • deleteCount: number

    The amount of text display components to remove

  • ...components: RestOrArray<
        | APITextDisplayComponent
        | TextDisplayBuilder
        | ((builder: TextDisplayBuilder) => TextDisplayBuilder),
    >

    The text display components to insert

  Returns this

toJSON

• toJSON(): APISectionComponent

  Serializes this builder to API-compatible JSON data.

  Returns APISectionComponent

  Remarks

  This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.