Class ContainerBuilder

constructor

• new ContainerBuilder(data?: Partial<APIContainerComponent>): ContainerBuilder

  Creates a new container from API data.

  Parameters

  • Optionaldata: Partial<APIContainerComponent>

    The API data to create this container with

  Returns ContainerBuilder

  Example

  Creating a container from an API data object:

  const container = new ContainerBuilder({
  	components: [
  		{
  			content: "Some text here",
  			type: ComponentType.TextDisplay,
  		},
  	],
  });
  Copy

  Example

  Creating a container using setters and API data:

  const container = new ContainerBuilder({
  	components: [
  		{
  			content: "# Heading",
  			type: ComponentType.TextDisplay,
  		},
  	],
  })
  	.addComponents(separator, section);
  Copy

Readonlycomponents

addActionRowComponents

• addActionRowComponents<ComponentType extends MessageActionRowComponentBuilder>(
      ...components: RestOrArray<
          | APIActionRowComponent<APIComponentInMessageActionRow>
          | ActionRowBuilder<ComponentType>
          | (
              (
                  builder: ActionRowBuilder<ComponentType>,
              ) => ActionRowBuilder<ComponentType>
          ),
      >,
  ): this

  Adds action row components to this container.

  Type Parameters

  • ComponentType extends MessageActionRowComponentBuilder

  Parameters

  • ...components: RestOrArray<
        | APIActionRowComponent<APIComponentInMessageActionRow>
        | ActionRowBuilder<ComponentType>
        | (
            (
                builder: ActionRowBuilder<ComponentType>,
            ) => ActionRowBuilder<ComponentType>
        ),
    >

    The action row components to add

  Returns this

addFileComponents

• addFileComponents(
      ...components: RestOrArray<
          | APIFileComponent
          | FileBuilder
          | ((builder: FileBuilder) => FileBuilder),
      >,
  ): this

  Adds file components to this container.

  Parameters

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

    The file components to add

  Returns this

addMediaGalleryComponents

• addMediaGalleryComponents(
      ...components: RestOrArray<
          | APIMediaGalleryComponent
          | MediaGalleryBuilder
          | ((builder: MediaGalleryBuilder) => MediaGalleryBuilder),
      >,
  ): this

  Adds media gallery components to this container.

  Parameters

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

    The media gallery components to add

  Returns this

addSectionComponents

• addSectionComponents(
      ...components: RestOrArray<
          | APISectionComponent
          | SectionBuilder
          | ((builder: SectionBuilder) => SectionBuilder),
      >,
  ): this

  Adds section components to this container.

  Parameters

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

    The section components to add

  Returns this

addSeparatorComponents

• addSeparatorComponents(
      ...components: RestOrArray<
          | APISeparatorComponent
          | SeparatorBuilder
          | ((builder: SeparatorBuilder) => SeparatorBuilder),
      >,
  ): this

  Adds separator components to this container.

  Parameters

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

    The separator components to add

  Returns this

addTextDisplayComponents

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

  Adds text display components to this container.

  Parameters

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

    The text display components to add

  Returns this

clearAccentColor

• clearAccentColor(): this

  Clears the accent color of this container.

  Returns this

setAccentColor

• setAccentColor(color?: number | RGBTuple): this

  Sets the accent color of this container.

  Parameters

  • Optionalcolor: number | RGBTuple

    The color to use

  Returns this

setSpoiler

• setSpoiler(spoiler?: boolean): this

  Sets the spoiler status of this container.

  Parameters

  • Optionalspoiler: boolean

    The spoiler status to use

  Returns this

spliceComponents

• spliceComponents(
      index: number,
      deleteCount: number,
      ...components: RestOrArray<
          APIComponentInContainer
          | ContainerComponentBuilder,
      >,
  ): this

  Removes, replaces, or inserts components for this container.

  Parameters

  • index: number

    The index to start removing, replacing or inserting components

  • deleteCount: number

    The amount of components to remove

  • ...components: RestOrArray<APIComponentInContainer | ContainerComponentBuilder>

    The components to set

  Returns this

toJSON

• toJSON(): APIContainerComponent

  Serializes this builder to API-compatible JSON data.

  Returns APIContainerComponent

  Remarks

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