Class ComponentBuilder<DataType>Abstract

constructor

• new ComponentBuilder<
      DataType extends
          Partial<APIBaseComponent<ComponentType>> = APIBaseComponent<
          ComponentType,
      >,
  >(
      data: Partial<DataType>,
  ): ComponentBuilder<DataType>

  Constructs a new kind of component.

  Type Parameters

  • DataType extends Partial<APIBaseComponent<ComponentType>> = APIBaseComponent<ComponentType>

  Parameters

  • data: Partial<DataType>

    The data to construct a component out of

  Returns ComponentBuilder<DataType>

Readonlydata

clearId

• clearId(): this

  Clears the id of this component, defaulting to a default incremented id.

  Returns this

setId

• setId(id: number): this

  Sets the id (not the custom id) for this component.

  Parameters

  • id: number

    The id for this component

  Returns this

AbstracttoJSON

• toJSON(): AnyAPIActionRowComponent

  Serializes this builder to API-compatible JSON data.

  Returns AnyAPIActionRowComponent

  Remarks

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