discord.js | FileBuilder

Search...

FileBuilder

export declare class FileBuilder extends ComponentBuilder<APIFileComponent>

export declare class FileBuilder extends ComponentBuilder<APIFileComponent>

No summary provided.

constructor(data?)

Creates a new file from API data.

Creating a file from an API data object:

const file = new FileBuilder({
	spoiler: true,
	file: {
		url: 'attachment://file.png',
	},
});

const file = new FileBuilder({
	spoiler: true,
	file: {
		url: 'attachment://file.png',
	},
});

Creating a file using setters and API data:

const file = new FileBuilder({
	file: {
		url: 'attachment://image.jpg',
	},
})
	.setSpoiler(false);

const file = new FileBuilder({
	file: {
		url: 'attachment://image.jpg',
	},
})
	.setSpoiler(false);

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

Readonly

The API data associated with this component.

clearId():this

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

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

setSpoiler(spoiler?):this

Sets the spoiler status of this file.

Name	Type	Optional	Description
spoiler	boolean	Yes	The spoiler status to use

setURL(url):this

Sets the media URL of this file.

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