discord.js | TextInputBuilder

Search...

TextInputBuilder

export class TextInputBuilder extends BuilderTextInputComponent

export class TextInputBuilder extends BuilderTextInputComponent

Represents a text input builder.

constructor(data?)

Constructs a new instance of the TextInputBuilder class

Name	Type	Optional	Description
data	Partial<TextInputComponentData \| APITextInputComponent>	Yes	None

Readonly

data:Partial<DataType>

The API data associated with this component.

equals(other):boolean

Name	Type	Optional	Description
other	APITextInputComponent \| JSONEncodable<APITextInputComponent>	No	None

Static

Creates a new text input builder from JSON data

Name	Type	Optional	Description
other	JSONEncodable<APITextInputComponent> \| APITextInputComponent	No	The other data

setCustomId(customId):this

Sets the custom id for this text input.

Name	Type	Optional	Description
customId	string	No	The custom id to use

setLabel(label):this

Sets the label for this text input.

Name	Type	Optional	Description
label	string	No	The label to use

setMaxLength(maxLength):this

Sets the maximum length of text for this text input.

Name	Type	Optional	Description
maxLength	number	No	The maximum length of text for this text input

setMinLength(minLength):this

Sets the minimum length of text for this text input.

Name	Type	Optional	Description
minLength	number	No	The minimum length of text for this text input

setPlaceholder(placeholder):this

Sets the placeholder for this text input.

Name	Type	Optional	Description
placeholder	string	No	The placeholder to use

setRequired(required?):this

Sets whether this text input is required.

Name	Type	Optional	Description
required	boolean	Yes	Whether this text input is required

setStyle(style):this

Sets the style for this text input.

Name	Type	Optional	Description
style	TextInputStyle	No	The style to use

setValue(value):this

Sets the value for this text input.

Name	Type	Optional	Description
value	string	No	The value 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.