Preview environment
builders

class SeparatorBuilder

export declare class SeparatorBuilder extends ComponentBuilder<APISeparatorComponent>

Constructors

constructor(
data?: Partial<APISeparatorComponent>
)

Creates a new separator from API data.

Examples:Creating a separator from an API data object:
const separator = new SeparatorBuilder({
	spacing: SeparatorSpacingSize.Small,
 divider: true,
});
Creating a separator using setters and API data:
const separator = new SeparatorBuilder({
	spacing: SeparatorSpacingSize.Large,
})
	.setDivider(false);

readonly
data : Partial<APISeparatorComponent>

The API data associated with this component.

Inherited from: ComponentBuilder

clearId() : this

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

Inherited from: ComponentBuilder

clearSpacing() : this

Clears the spacing of this separator.

setDivider(
divider?: boolean
) : this

Sets whether this separator should show a divider line.

setId(
id: number
) : this

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

Inherited from: ComponentBuilder

setSpacing(
spacing: SeparatorSpacingSize
) : this

Sets the spacing of this separator.

toJSON() : APISeparatorComponent

Serializes this builder to API-compatible JSON data.