Skip to content

CreateEmbed

Defined in: packages/builders/src/embed.ts:52

Builds compile-time-safe rich embed payloads for Discord API requests.

new CreateEmbed(): CreateEmbed

CreateEmbed

get data(): APIEmbed

Defined in: packages/builders/src/embed.ts:203

Returns a deep-cloned Discord API payload.

APIEmbed

Strict embed payload.

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]).

EmbedField[] | [EmbedField[]]

Field payloads, spread or as a single array.

this

This builder.

If the 25-field limit is exceeded.


clearDescription(): this

Defined in: packages/builders/src/embed.ts:198

Removes the embed description.

this

This builder.


clearFields(): this

Defined in: packages/builders/src/embed.ts:188

Removes all embed fields.

this

This builder.


clearTitle(): this

Defined in: packages/builders/src/embed.ts:193

Removes the embed title.

this

This builder.


setAuthor(value): this

Defined in: packages/builders/src/embed.ts:101

Sets the embed author.

EmbedAuthor

Author payload.

this

This builder.

If author name exceeds Discord’s limit.


setColor(value): this

Defined in: packages/builders/src/embed.ts:74

Sets the embed color.

number

RGB integer.

this

This builder.

If color is outside 24-bit RGB range.


setDescription(value): this

Defined in: packages/builders/src/embed.ts:61

Sets the embed description.

string | null

Description text, or null to clear.

this

This builder.

If description exceeds Discord’s limit.


setFields(fields): this

Defined in: packages/builders/src/embed.ts:155

EmbedField[]

this


setFooter(value): this

Defined in: packages/builders/src/embed.ts:91

Sets the embed footer.

EmbedFooter

Footer payload.

this

This builder.

If footer text exceeds Discord’s limit.


setImage(value): this

Defined in: packages/builders/src/embed.ts:122

Sets the image URL.

string | { url: string; } | null

Image URL or payload, or null to clear.

this

This builder.

If URL is invalid.


setThumbnail(value): this

Defined in: packages/builders/src/embed.ts:112

Sets the thumbnail URL.

string | { url: string; } | null

Thumbnail URL or payload, or null to clear.

this

This builder.

If URL is invalid.


setTimestamp(value?): this

Defined in: packages/builders/src/embed.ts:83

Sets the embed timestamp.

Date = ...

Date value.

this

This builder.

If date is invalid.


setTitle(value): this

Defined in: packages/builders/src/embed.ts:55

Sets the embed title.

string | null

Title text, or null to clear.

this

This builder.

If title exceeds Discord’s limit.


setURL(value): this

Defined in: packages/builders/src/embed.ts:68

Sets the embed URL.

string | null

Absolute URL, or null to clear.

this

This builder.

If URL is invalid.


spliceFields(index, deleteCount, …fields): this

Defined in: packages/builders/src/embed.ts:160

Replaces fields starting at an index.

number

Start index.

number

Number of fields to remove.

…EmbedField[]

Replacement fields.

this

This builder.

If arguments are invalid or the 25-field limit is exceeded.


toJSON(): APIEmbed

Defined in: packages/builders/src/embed.ts:207

Returns a deep-cloned Discord API payload.

APIEmbed

Strict embed payload.

If the text in the embed adds up to more than Discord’s 6000-character limit.