discord.js | ThumbnailBuilder

Search...

ThumbnailBuilder

export declare class ThumbnailBuilder extends ComponentBuilder<APIThumbnailComponent>

export declare class ThumbnailBuilder extends ComponentBuilder<APIThumbnailComponent>

No summary provided.

constructor(data?)

Creates a new thumbnail from API data.

Creating a thumbnail from an API data object:

const thumbnail = new ThumbnailBuilder({
	description: 'some text',
 media: {
     url: 'https://cdn.discordapp.com/embed/avatars/4.png',
 },
});

const thumbnail = new ThumbnailBuilder({
	description: 'some text',
 media: {
     url: 'https://cdn.discordapp.com/embed/avatars/4.png',
 },
});

Creating a thumbnail using setters and API data:

const thumbnail = new ThumbnailBuilder({
	media: {
     url: 'attachment://image.png',
 },
})
	.setDescription('alt text');

const thumbnail = new ThumbnailBuilder({
	media: {
     url: 'attachment://image.png',
 },
})
	.setDescription('alt text');

Name	Type	Optional	Description
data	Partial<APIThumbnailComponent>	Yes	The API data to create this thumbnail with

Readonly

The API data associated with this component.

clearDescription():this

Clears the description of this thumbnail.

clearId():this

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

setDescription(description):this

Sets the description of this thumbnail.

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

setSpoiler(spoiler?):this

Sets the spoiler status of this thumbnail.

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

setURL(url):this

Sets the media URL of this thumbnail.

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.