discord.js | SeparatorBuilder

Search...

SeparatorBuilder

export declare class SeparatorBuilder extends ComponentBuilder<APISeparatorComponent>

export declare class SeparatorBuilder extends ComponentBuilder<APISeparatorComponent>

No summary provided.

constructor(data?)

Creates a new separator from API data.

Creating a separator from an API data object:

const separator = new SeparatorBuilder({
	spacing: SeparatorSpacingSize.Small,
 divider: true,
});

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);

const separator = new SeparatorBuilder({
	spacing: SeparatorSpacingSize.Large,
})
	.setDivider(false);

Name	Type	Optional	Description
data	Partial<APISeparatorComponent>	Yes	The API data to create this separator with

Readonly

The API data associated with this component.

clearId():this

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

clearSpacing():this

Clears the spacing of this separator.

setDivider(divider?):this

Sets whether this separator should show a divider line.

Name	Type	Optional	Description
divider	boolean	Yes	Whether to show a divider line

setId(id):this

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

Name	Type	Optional	Description
id	number	No	The id for this component

setSpacing(spacing):this

Sets the spacing of this separator.

Name	Type	Optional	Description
spacing	SeparatorSpacingSize	No	The spacing to use

Serializes this builder to API-compatible JSON data.

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