CreateEmbed
Defined in: packages/builders/src/embed.ts:52
Builds compile-time-safe rich embed payloads for Discord API requests.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CreateEmbed():
CreateEmbed
Returns
Section titled “Returns”CreateEmbed
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get data():
APIEmbed
Defined in: packages/builders/src/embed.ts:203
Returns a deep-cloned Discord API payload.
Returns
Section titled “Returns”APIEmbed
Strict embed payload.
Methods
Section titled “Methods”addFields()
Section titled “addFields()”addFields(…
fields):this
Defined in: packages/builders/src/embed.ts:134
Adds embed fields. Accepts both the spread form addFields(a, b) and the
single-array form addFields([a, b]).
Parameters
Section titled “Parameters”fields
Section titled “fields”EmbedField[] | [EmbedField[]]
Field payloads, spread or as a single array.
Returns
Section titled “Returns”this
This builder.
Throws
Section titled “Throws”If the 25-field limit is exceeded.
clearDescription()
Section titled “clearDescription()”clearDescription():
this
Defined in: packages/builders/src/embed.ts:198
Removes the embed description.
Returns
Section titled “Returns”this
This builder.
clearFields()
Section titled “clearFields()”clearFields():
this
Defined in: packages/builders/src/embed.ts:188
Removes all embed fields.
Returns
Section titled “Returns”this
This builder.
clearTitle()
Section titled “clearTitle()”clearTitle():
this
Defined in: packages/builders/src/embed.ts:193
Removes the embed title.
Returns
Section titled “Returns”this
This builder.
setAuthor()
Section titled “setAuthor()”setAuthor(
value):this
Defined in: packages/builders/src/embed.ts:101
Sets the embed author.
Parameters
Section titled “Parameters”EmbedAuthor
Author payload.
Returns
Section titled “Returns”this
This builder.
Throws
Section titled “Throws”If author name exceeds Discord’s limit.
setColor()
Section titled “setColor()”setColor(
value):this
Defined in: packages/builders/src/embed.ts:74
Sets the embed color.
Parameters
Section titled “Parameters”number
RGB integer.
Returns
Section titled “Returns”this
This builder.
Throws
Section titled “Throws”If color is outside 24-bit RGB range.
setDescription()
Section titled “setDescription()”setDescription(
value):this
Defined in: packages/builders/src/embed.ts:61
Sets the embed description.
Parameters
Section titled “Parameters”string | null
Description text, or null to clear.
Returns
Section titled “Returns”this
This builder.
Throws
Section titled “Throws”If description exceeds Discord’s limit.
setFields()
Section titled “setFields()”setFields(
fields):this
Defined in: packages/builders/src/embed.ts:155
Parameters
Section titled “Parameters”fields
Section titled “fields”Returns
Section titled “Returns”this
setFooter()
Section titled “setFooter()”setFooter(
value):this
Defined in: packages/builders/src/embed.ts:91
Sets the embed footer.
Parameters
Section titled “Parameters”EmbedFooter
Footer payload.
Returns
Section titled “Returns”this
This builder.
Throws
Section titled “Throws”If footer text exceeds Discord’s limit.
setImage()
Section titled “setImage()”setImage(
value):this
Defined in: packages/builders/src/embed.ts:122
Sets the image URL.
Parameters
Section titled “Parameters”string | { url: string; } | null
Image URL or payload, or null to clear.
Returns
Section titled “Returns”this
This builder.
Throws
Section titled “Throws”If URL is invalid.
setThumbnail()
Section titled “setThumbnail()”setThumbnail(
value):this
Defined in: packages/builders/src/embed.ts:112
Sets the thumbnail URL.
Parameters
Section titled “Parameters”string | { url: string; } | null
Thumbnail URL or payload, or null to clear.
Returns
Section titled “Returns”this
This builder.
Throws
Section titled “Throws”If URL is invalid.
setTimestamp()
Section titled “setTimestamp()”setTimestamp(
value?):this
Defined in: packages/builders/src/embed.ts:83
Sets the embed timestamp.
Parameters
Section titled “Parameters”value?
Section titled “value?”Date = ...
Date value.
Returns
Section titled “Returns”this
This builder.
Throws
Section titled “Throws”If date is invalid.
setTitle()
Section titled “setTitle()”setTitle(
value):this
Defined in: packages/builders/src/embed.ts:55
Sets the embed title.
Parameters
Section titled “Parameters”string | null
Title text, or null to clear.
Returns
Section titled “Returns”this
This builder.
Throws
Section titled “Throws”If title exceeds Discord’s limit.
setURL()
Section titled “setURL()”setURL(
value):this
Defined in: packages/builders/src/embed.ts:68
Sets the embed URL.
Parameters
Section titled “Parameters”string | null
Absolute URL, or null to clear.
Returns
Section titled “Returns”this
This builder.
Throws
Section titled “Throws”If URL is invalid.
spliceFields()
Section titled “spliceFields()”spliceFields(
index,deleteCount, …fields):this
Defined in: packages/builders/src/embed.ts:160
Replaces fields starting at an index.
Parameters
Section titled “Parameters”number
Start index.
deleteCount
Section titled “deleteCount”number
Number of fields to remove.
fields
Section titled “fields”…EmbedField[]
Replacement fields.
Returns
Section titled “Returns”this
This builder.
Throws
Section titled “Throws”If arguments are invalid or the 25-field limit is exceeded.
toJSON()
Section titled “toJSON()”toJSON():
APIEmbed
Defined in: packages/builders/src/embed.ts:207
Returns a deep-cloned Discord API payload.
Returns
Section titled “Returns”APIEmbed
Strict embed payload.
Throws
Section titled “Throws”If the text in the embed adds up to more than Discord’s 6000-character limit.