discord.js | FileUploadBuilder

Search...

FileUploadBuilder

export declare class FileUploadBuilder extends ComponentBuilder<APIFileUploadComponent>

export declare class FileUploadBuilder extends ComponentBuilder<APIFileUploadComponent>

A builder that creates API-compatible JSON data for file uploads.

constructor(data?)

Creates a new file upload.

Creating a file upload from an API data object:

const fileUpload = new FileUploadBuilder({
	custom_id: "file_upload",
 min_values: 2,
 max_values: 5,
});

const fileUpload = new FileUploadBuilder({
	custom_id: "file_upload",
 min_values: 2,
 max_values: 5,
});

Creating a file upload using setters and API data:

const fileUpload = new FileUploadBuilder({
	custom_id: "file_upload",
 min_values: 2,
 max_values: 5,
}).setRequired();

const fileUpload = new FileUploadBuilder({
	custom_id: "file_upload",
 min_values: 2,
 max_values: 5,
}).setRequired();

Name	Type	Optional	Description
data	Partial<APIFileUploadComponent>	Yes	The API data to create this file upload with

Readonly

The API data associated with this component.

clearId():this

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

clearMaxValues():this

Clears the maximum values.

clearMinValues():this

Clears the minimum values.

setCustomId(customId):this

Sets the custom id for this file upload.

Name	Type	Optional	Description
customId	string	No	The custom id 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

setMaxValues(maxValues):this

Sets the maximum number of file uploads required.

Name	Type	Optional	Description
maxValues	number	No	The maximum values that can be uploaded

setMinValues(minValues):this

Sets the minimum number of file uploads required.

Name	Type	Optional	Description
minValues	number	No	The minimum values that must be uploaded

setRequired(required?):this

Sets whether this file upload is required.

Name	Type	Optional	Description
required	boolean	Yes	Whether this file upload is required

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.