discord.js | LabelBuilder

Search...

LabelBuilder

export declare class LabelBuilder extends ComponentBuilder<LabelBuilderData>

export declare class LabelBuilder extends ComponentBuilder<LabelBuilderData>

A builder that creates API-compatible JSON data for labels.

Extends

ComponentBuilder<LabelBuilderData>

constructor(data?)

Creates a new label.

Example

Creating a label from an API data object:

const label = new LabelBuilder({
	label: "label",
	component,
});

const label = new LabelBuilder({
	label: "label",
	component,
});

Example

Creating a label using setters and API data:

const label = new LabelBuilder({
	label: 'label',
	component,
}).setLabel('new text');

const label = new LabelBuilder({
	label: 'label',
	component,
}).setLabel('new text');

Name	Type	Optional	Description
data	Partial<APILabelComponent>	Yes	The API data to create this label with

Readonly

data:Partial<LabelBuilderData>

The API data associated with this component.

Inherited from ComponentBuilder

clearDescription():this

Clears the description for this label.

clearId():this

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

Inherited from ComponentBuilder

setChannelSelectMenuComponent(input):this

Sets a channel select menu component to this label.

Name	Type	Optional	Description
input	APIChannelSelectComponent \| ChannelSelectMenuBuilder \| ((builder: ChannelSelectMenuBuilder) => ChannelSelectMenuBuilder)	No	A function that returns a component builder or an already built builder

setDescription(description):this

Sets the description for this label.

Name	Type	Optional	Description
description	string	No	The description to use

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

Inherited from ComponentBuilder

setLabel(label):this

Sets the label for this label.

Name	Type	Optional	Description
label	string	No	The label to use

setMentionableSelectMenuComponent(input):this

Sets a mentionable select menu component to this label.

Name	Type	Optional	Description
input	APIMentionableSelectComponent \| MentionableSelectMenuBuilder \| ((builder: MentionableSelectMenuBuilder) => MentionableSelectMenuBuilder)	No	A function that returns a component builder or an already built builder

setRoleSelectMenuComponent(input):this

Sets a role select menu component to this label.

Name	Type	Optional	Description
input	APIRoleSelectComponent \| RoleSelectMenuBuilder \| ((builder: RoleSelectMenuBuilder) => RoleSelectMenuBuilder)	No	A function that returns a component builder or an already built builder

setStringSelectMenuComponent(input):this

Sets a string select menu component to this label.

Name	Type	Optional	Description
input	APIStringSelectComponent \| StringSelectMenuBuilder \| ((builder: StringSelectMenuBuilder) => StringSelectMenuBuilder)	No	A function that returns a component builder or an already built builder

setTextInputComponent(input):this

Sets a text input component to this label.

Name	Type	Optional	Description
input	APITextInputComponent \| TextInputBuilder \| ((builder: TextInputBuilder) => TextInputBuilder)	No	A function that returns a component builder or an already built builder

setUserSelectMenuComponent(input):this

Sets a user select menu component to this label.

Name	Type	Optional	Description
input	APIUserSelectComponent \| UserSelectMenuBuilder \| ((builder: UserSelectMenuBuilder) => UserSelectMenuBuilder)	No	A function that returns a component builder or an already built builder

toJSON():APILabelComponent

Serializes this builder to API-compatible JSON data.

Remarks

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