feat(embed): add setFields (#7322)

discordjs · Jan 24, 2022 · bcc5cda · bcc5cda
1 parent d2d3a80
commit bcc5cda
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/packages/builders/__tests__/messages/embed.test.ts b/packages/builders/__tests__/messages/embed.test.ts
@@ -391,6 +391,22 @@ describe('Embed', () => {
 			).toThrowError();
 		});
 
+		test('GIVEN an embed using Embed#setFields THEN returns valid toJSON data', () => {
+			const embed = new Embed();
+
+			expect(() =>
+				embed.setFields(...Array.from({ length: 25 }, () => ({ name: 'foo', value: 'bar' }))),
+			).not.toThrowError();
+		});
+
+		test('GIVEN an embed using Embed#setFields that sets more than 25 fields THEN throws error', () => {
+			const embed = new Embed();
+
+			expect(() =>
+				embed.setFields(...Array.from({ length: 26 }, () => ({ name: 'foo', value: 'bar' }))),
+			).toThrowError();
+		});
+
 		describe('GIVEN invalid field amount THEN throws error', () => {
 			test('', () => {
 				const embed = new Embed();

diff --git a/packages/builders/src/messages/embed/Embed.ts b/packages/builders/src/messages/embed/Embed.ts
@@ -170,6 +170,15 @@ export class Embed implements APIEmbed {
 		return this;
 	}
 
+	/**
+	 * Sets the embed's fields (max 25).
+	 * @param fields The fields to set
+	 */
+	public setFields(...fields: APIEmbedField[]) {
+		this.spliceFields(0, this.fields.length, ...fields);
+		return this;
+	}
+
 	/**
 	 * Sets the author of this embed
 	 *