discord.js | EmbedBuilder

Search...

EmbedBuilder

export declare class EmbedBuilder implements JSONEncodable<APIEmbed>

export declare class EmbedBuilder implements JSONEncodable<APIEmbed>

A builder that creates API-compatible JSON data for embeds.

Implements

JSONEncodable<APIEmbed>

constructor(data?)

Creates a new embed from API data.

Name	Type	Optional	Description
data	APIEmbed	Yes	The API data to create this embed with

Readonly

fields:readonly EmbedFieldBuilder[]

Gets the fields of this embed.

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 \| EmbedFieldBuilder \| ((builder: EmbedFieldBuilder) => EmbedFieldBuilder)>	No	The fields to add

clearAuthor():this

Clears the author of this embed.

clearColor():this

Clears the color of this embed.

clearDescription():this

Clears the description of this embed.

clearFooter():this

Clears the footer of this embed.

clearImage():this

Clears the image of this embed.

clearThumbnail():this

Clears the thumbnail of this embed.

clearTimestamp():this

Clears the timestamp of this embed.

clearTitle():this

Clears the title of this embed.

clearURL():this

Clears the URL of this embed.

setAuthor(options):this

Sets the author of this embed.

Name	Type	Optional	Description
options	APIEmbedAuthor \| EmbedAuthorBuilder \| ((builder: EmbedAuthorBuilder) => EmbedAuthorBuilder)	No	The options to use

setColor(color):this

Sets the color of this embed.

Name	Type	Optional	Description
color	number	No	The color to use

setDescription(description):this

Sets the description of this embed.

Name	Type	Optional	Description
description	string	No	The description to use

setFields(...fields):this

Sets the fields for this embed.

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 \| EmbedFieldBuilder \| ((builder: EmbedFieldBuilder) => EmbedFieldBuilder)>	No	The fields to set

setFooter(options):this

Sets the footer of this embed.

Name	Type	Optional	Description
options	APIEmbedFooter \| EmbedFooterBuilder \| ((builder: EmbedFooterBuilder) => EmbedFooterBuilder)	No	The footer to use

setImage(url):this

Sets the image of this embed.

Name	Type	Optional	Description
url	string	No	The image URL to use

setThumbnail(url):this

Sets the thumbnail of this embed.

Name	Type	Optional	Description
url	string	No	The thumbnail URL to use

setTimestamp(timestamp?):this

Sets the timestamp of this embed.

Name	Type	Optional	Description
timestamp	Date \| number \| string	Yes	The timestamp or date to use

setTitle(title):this

Sets the title for this embed.

Name	Type	Optional	Description
title	string	No	The title to use

setURL(url):this

Sets the URL of this embed.

Name	Type	Optional	Description
url	string	No	The URL to use

spliceFields(index, deleteCount, ...fields):this

Removes, replaces, or inserts fields for this 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 \| EmbedFieldBuilder \| ((builder: EmbedFieldBuilder) => EmbedFieldBuilder))[]	No	The replacing field objects

toJSON(validationOverride?):APIEmbed

Serializes this builder to API-compatible JSON data.

Note that by disabling validation, there is no guarantee that the resulting object will be valid.

Name	Type	Optional	Description
validationOverride	boolean	Yes	Force validation to run/not run regardless of your global preference

updateAuthor(updater):this

Updates the author of this embed (and creates it if it doesn't exist).

Name	Type	Optional	Description
updater	(builder: EmbedAuthorBuilder) => void	No	The function to update the author with

updateFooter(updater):this

Updates the footer of this embed (and creates it if it doesn't exist).

Name	Type	Optional	Description
updater	(builder: EmbedFooterBuilder) => void	No	The function to update the footer with