class EmbedBuilder

external
declare class EmbedBuilder implements JSONEncodable<APIEmbed>

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

fields
addFields
clearAuthor
clearColor
clearDescription
clearFooter
clearImage
clearThumbnail
clearTimestamp
clearTitle
clearURL
setAuthor
setColor
setDescription
setFields
setFooter
setImage
setThumbnail
setTimestamp
setTitle
setURL
spliceFields
toJSON
updateAuthor
updateFooter

Constructors

external
constructor(
data?: Partial<APIEmbed>
)

Creates a new embed.

readonlyexternal
fields : readonly EmbedFieldBuilder[]

Gets the fields of this embed.

external
addFields(
...fields: RestOrArray<APIEmbedField | EmbedFieldBuilder | ((builder: EmbedFieldBuilder) => EmbedFieldBuilder)>
) : this

Appends fields to the embed.

Examples:Using an array:
const fields: APIEmbedField[] = ...;
const embed = new EmbedBuilder()
	.addFields(fields);
Using rest parameters (variadic):
const embed = new EmbedBuilder()
	.addFields(
		{ name: 'Field 1', value: 'Value 1' },
		{ name: 'Field 2', value: 'Value 2' },
	);

external
clearAuthor() : this

Clears the author of this embed.

external
clearColor() : this

Clears the color of this embed.

external
clearDescription() : this

Clears the description of this embed.

external
clearFooter() : this

Clears the footer of this embed.

external
clearImage() : this

Clears the image of this embed.

external
clearThumbnail() : this

Clears the thumbnail of this embed.

external
clearTimestamp() : this

Clears the timestamp of this embed.

external
clearTitle() : this

Clears the title of this embed.

external
clearURL() : this

Clears the URL of this embed.

external
setAuthor(
options: APIEmbedAuthor | EmbedAuthorBuilder | ((builder: EmbedAuthorBuilder) => EmbedAuthorBuilder)
) : this

Sets the author of this embed.

external
setColor(
color: number
) : this

Sets the color of this embed.

external
setDescription(
description: string
) : this

Sets the description of this embed.

external
setFields(
...fields: RestOrArray<APIEmbedField | EmbedFieldBuilder | ((builder: EmbedFieldBuilder) => EmbedFieldBuilder)>
) : this

Sets the fields for this embed.

external
setFooter(
options: APIEmbedFooter | EmbedFooterBuilder | ((builder: EmbedFooterBuilder) => EmbedFooterBuilder)
) : this

Sets the footer of this embed.

external
setImage(
url: string
) : this

Sets the image of this embed.

external
setThumbnail(
url: string
) : this

Sets the thumbnail of this embed.

external
setTimestamp(
timestamp?: Date | number | string
) : this

Sets the timestamp of this embed.

external
setTitle(
title: string
) : this

Sets the title for this embed.

external
setURL(
url: string
) : this

Sets the URL of this embed.

external
spliceFields(
index: number
deleteCount: number
...fields: (APIEmbedField | EmbedFieldBuilder | ((builder: EmbedFieldBuilder) => EmbedFieldBuilder))[]
) : this

Removes, replaces, or inserts fields for this embed.

Examples:Remove the first field:
embed.spliceFields(0, 1);
Remove the first n fields:
const n = 4;
embed.spliceFields(0, n);
Remove the last field:
embed.spliceFields(-1, 1);

external
toJSON(
validationOverride?: boolean
) : 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.

external
updateAuthor(
updater: (builder: EmbedAuthorBuilder) => void
) : this

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

external
updateFooter(
updater: (builder: EmbedFooterBuilder) => void
) : this

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