EmbedBuilder
Represents a embed in a message (image/video preview, rich embed, etc.)
export declare class EmbedBuilder
constructor(data?)
Constructs a new instance of the
EmbedBuilder
classAppends 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);
Example
Using rest parameters (variadic)
const embed = new EmbedBuilder()
.addFields(
{ name: 'Field 1', value: 'Value 1' },
{ name: 'Field 2', value: 'Value 2' },
);
Sets the embed's fields
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.
Removes, replaces, or inserts fields in the 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);
Example
Remove the first n fields
const n = 4
embed.spliceFields(0, n);
Example
Remove the last field
embed.spliceFields(-1, 1);