.addFields(fields)
fields: EmbedFieldData[] → this
Add fields (up to 25 total). Existing fields are preserved.
- fields
EmbedFieldData[]Field objects to append
embedBuilder.addFields(fields);Class
EmbedBuilder
Request-only embed builder. Emits RESTPostAPIEmbed (no video/audio).
Constructor
new EmbedBuilder()Properties
| Name | Type | Description |
|---|---|---|
| dataread-only | Partial<RESTPostAPIEmbed> | Partial embed data (built incrementally via setters). |
Methods
static from(data)
data: APIEmbed | RESTPostAPIEmbed | EmbedFromInput → EmbedBuilder
Copy request fields only. Response video/audio/type/provider are ignored. Accepts wire APIEmbed / RESTPostAPIEmbed or a camelCase received embed.
- data
APIEmbed | RESTPostAPIEmbed | EmbedFromInputAPI embed from message or webhook
EmbedBuilder.from(data);.setAuthor(options)
options: EmbedAuthorOptions | null → this
Set embed author. Pass null to clear.
- options
EmbedAuthorOptions | nullAuthor name, icon URL, and URL, or null
embedBuilder.setAuthor(options);.setColor(color)
color: number | string | [number, number, number] | null → this
Set embed color. Pass null to clear.
- color
number | string | [number, number, number] | nullNumber (24-bit RGB), hex string (#5865F2), or RGB tuple, or null
embedBuilder.setColor(color);.setDescription(description)
description: string | null → this
Set embed description (max 4096 characters). Pass null to clear.
- description
string | nullDescription text or null
embedBuilder.setDescription(description);.setFields(fields)
fields: EmbedFieldData[] → this
Replace all fields (max 25). Pass empty array to clear.
- fields
EmbedFieldData[]Field objects (name, value, inline)
embedBuilder.setFields(fields);.setFooter(options)
options: EmbedFooterOptions | null → this
Set embed footer. Pass null to clear.
- options
EmbedFooterOptions | nullFooter text and optional icon URL, or null
embedBuilder.setFooter(options);.setImage(input)
input: string | EmbedMediaOptions | null → this
Set embed image (large media below description). Pass null to clear.
- input
string | EmbedMediaOptions | nullURL string or media options, or null
embedBuilder.setImage(input);.setThumbnail(input)
input: string | EmbedMediaOptions | null → this
Set embed thumbnail (small media in top-right corner). Pass null to clear.
- input
string | EmbedMediaOptions | nullURL string or media options, or null
embedBuilder.setThumbnail(input);.setTimestamp(timestamp?)
timestamp?: Date | number | null → this
Set embed timestamp. Pass null to clear.
- timestamp?
Date | number | nullDate object, Unix ms, or undefined (defaults to now), or null
embedBuilder.setTimestamp();.setTitle(title)
title: string | null → this
Set embed title (max 256 characters). Pass null to clear.
- title
string | nullTitle text or null
embedBuilder.setTitle(title);.setURL(url)
url: string | null → this
Set embed URL (title becomes clickable). Pass null to clear.
- url
string | nullHTTP(S) URL or null
embedBuilder.setURL(url);.spliceFields(index, deleteCount, fields)
index: number, deleteCount: number, fields: EmbedFieldData[] → this
Splice fields (like Array.prototype.splice).
- index
numberStart index- deleteCount
numberNumber of fields to remove- fields
EmbedFieldData[]Fields to insert at index
embedBuilder.spliceFields(index, deleteCount, fields);