discord.js | EmbedBuilder

Search...

EmbedBuilder

declare class EmbedBuilder

declare class EmbedBuilder

Represents a embed in a message (image/video preview, rich embed, etc.)

constructor(data?)

Constructs a new instance of the EmbedBuilder class

Name	Type	Optional	Description
data	APIEmbed	Yes	None

Readonly

data:APIEmbed

addFields(fields):this

Appends fields to the embed

Remarks

This method accepts either an array of fields or a variable number of field parameters. The maximum amount of fields that can be added is 25.

Example

Using an array

const fields: APIEmbedField[] = ...;
const embed = new EmbedBuilder()
	.addFields(fields);

const fields: APIEmbedField[] = ...;
const embed = new EmbedBuilder()
	.addFields(fields);

Example

Using rest parameters (variadic)

const embed = new EmbedBuilder()
	.addFields(
		{ name: 'Field 1', value: 'Value 1' },
		{ name: 'Field 2', value: 'Value 2' },
	);

const embed = new EmbedBuilder()
	.addFields(
		{ name: 'Field 1', value: 'Value 1' },
		{ name: 'Field 2', value: 'Value 2' },
	);

Name	Type	Optional	Description
fields	RestOrArray<APIEmbedField>	No	The fields to add

setAuthor(options):this

Sets the author of this embed

Name	Type	Optional	Description
options	EmbedAuthorOptions \| null	No	The options for the author

setColor(color):this

Sets the color of this embed

Name	Type	Optional	Description
color	RGBTuple \| number \| null	No	The color of the embed

setDescription(description):this

Sets the description of this embed

Name	Type	Optional	Description
description	string \| null	No	The description

setFields(fields):this

Sets the embed's fields

Remarks

This method is an alias for spliceFields. More specifically, it splices the entire array of fields, replacing them with the provided fields.You can set a maximum of 25 fields.

Name	Type	Optional	Description
fields	RestOrArray<APIEmbedField>	No	The fields to set

setFooter(options):this

Sets the footer of this embed

Name	Type	Optional	Description
options	EmbedFooterOptions \| null	No	The options for the footer

setImage(url):this

Sets the image of this embed

Name	Type	Optional	Description
url	string \| null	No	The URL of the image

setThumbnail(url):this

Sets the thumbnail of this embed

Name	Type	Optional	Description
url	string \| null	No	The URL of the thumbnail

setTimestamp(timestamp?):this

Sets the timestamp of this embed

Name	Type	Optional	Description
timestamp	Date \| number \| null	Yes	The timestamp or date

setTitle(title):this

Sets the title of this embed

Name	Type	Optional	Description
title	string \| null	No	The title

setURL(url):this

Sets the URL of this embed

Name	Type	Optional	Description
url	string \| null	No	The URL

spliceFields(index, deleteCount, fields):this

Removes, replaces, or inserts fields in the embed.

Remarks

This method behaves similarly to Array.prototype.splice. The maximum amount of fields that can be added is 25.It's useful for modifying and adjusting order of the already-existing fields of an embed.

Example

Remove the first field

embed.spliceFields(0, 1);

embed.spliceFields(0, 1);

Example

Remove the first n fields

const n = 4
embed.spliceFields(0, n);

const n = 4
embed.spliceFields(0, n);

Example

Remove the last field

embed.spliceFields(-1, 1);

embed.spliceFields(-1, 1);

Name	Type	Optional	Description
index	number	No	The index to start at
deleteCount	number	No	The number of fields to remove
fields	APIEmbedField[]	No	The replacing field objects

toJSON():APIEmbed

Transforms the embed to a plain object