discord.js | TextDisplayBuilder

Search...

TextDisplayBuilder

export declare class TextDisplayBuilder extends ComponentBuilder<APITextDisplayComponent>

export declare class TextDisplayBuilder extends ComponentBuilder<APITextDisplayComponent>

No summary provided.

constructor(data?)

Creates a new text display from API data.

Creating a text display from an API data object:

const textDisplay = new TextDisplayBuilder({
	content: 'some text',
});

const textDisplay = new TextDisplayBuilder({
	content: 'some text',
});

Creating a text display using setters and API data:

const textDisplay = new TextDisplayBuilder({
	content: 'old text',
})
	.setContent('new text');

const textDisplay = new TextDisplayBuilder({
	content: 'old text',
})
	.setContent('new text');

Name	Type	Optional	Description
data	Partial<APITextDisplayComponent>	Yes	The API data to create this text display with

ProtectedReadonly

clearId():this

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

setContent(content):this

Sets the text of this text display.

Name	Type	Optional	Description
content	string	No	The text to use

setId(id):this

Sets the id of this component.

Name	Type	Optional	Description
id	number	No	The id to use

toJSON(validationOverride?):APITextDisplayComponent

Serializes this builder to API-compatible JSON data.

Note that by disabling validation, there is no guarantee that the resulting object will be valid.

Name	Type	Optional	Description
validationOverride	boolean	Yes	Force validation to run/not run regardless of your global preference