✨ support for embedFooter.iconURL

Androz2091 · Jun 12, 2021 · 35ec38f · 35ec38f · Nico105 · Jun 12, 2021
1 parent 17f4fd2
commit 35ec38f
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 4 deletions.
diff --git a/examples/custom-databases/mongoose.js b/examples/custom-databases/mongoose.js
@@ -32,7 +32,7 @@ const giveawaySchema = new mongoose.Schema({
         inviteToParticipate: String,
         timeRemaining: String,
         winMessage: String,
-        embedFooter: String,
+        embedFooter: mongoose.Mixed,
         noWinner: String,
         winners: String,
         endedAt: String,

diff --git a/src/Constants.js b/src/Constants.js
@@ -9,7 +9,7 @@ const Discord = require('discord.js');
  * @property {string} [inviteToParticipate='React with 🎉 to participate!'] Displayed in the giveaway embed. Incite people to react to the giveaway.
  * @property {string} [timeRemaining='Time remaining: **{duration}**'] Displayed below inviteToParticipate in the giveaway embed. {duration} will be replaced automatically with the time remaining.
  * @property {string} [winMessage='Congratulations, {winners}! You won **{prize}**!\n{messageURL}'] Sent in the channel when the giveaway is ended.
- * @property {string} [embedFooter='Powered by the discord-giveaways package'] The footer of the giveaway embed.
+ * @property {string|embedFooterObject} [embedFooter='Powered by the discord-giveaways package'] The footer of the giveaway embed.
  * @property {string} [noWinner='Giveaway cancelled, no valid participations.'] Sent in the channel if there's no valid winner for the giveaway.
  * @property {string} [winners='winner(s)'] Displayed next to the embed footer, used to display the number of winners of the giveaways.
  * @property {string} [endedAt='Ended at'] Displayed next to the embed footer, used to display the giveaway end date.
@@ -69,6 +69,14 @@ exports.defaultGiveawayMessages = {
     }
 };
 
+/**
+ * Embed Footer object.
+ * @typedef embedFooterObject
+ *
+ * @property {string} [text] The text of the footer.
+ * @property {string} [iconURL] The icon URL of the footer.
+ */
+
 /**
  * Bonus entry object.
  * @typedef BonusEntry

diff --git a/src/Manager.js b/src/Manager.js
@@ -63,7 +63,12 @@ class GiveawaysManager extends EventEmitter {
         embed
             .setTitle(giveaway.prize)
             .setColor(lastChanceEnabled ? giveaway.lastChance.embedColor : giveaway.embedColor)
-            .setFooter(`${giveaway.winnerCount} ${giveaway.messages.winners} • ${giveaway.messages.embedFooter}`)
+            .setFooter(
+                `${giveaway.winnerCount} ${giveaway.messages.winners} • ${
+                    giveaway.messages.embedFooter.text || giveaway.messages.embedFooter
+                }`,
+                giveaway.messages.embedFooter.iconURL
+            )
             .setDescription(
                 (lastChanceEnabled ? giveaway.lastChance.content + '\n\n' : '') +
                     giveaway.messages.inviteToParticipate +

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -89,7 +89,7 @@ declare module 'discord-giveaways' {
         inviteToParticipate?: string;
         timeRemaining?: string;
         winMessage?: string;
-        embedFooter?: string;
+        embedFooter?: string | { text: string; iconURL: string; };
         noWinner?: string;
         winners?: string;
         endedAt?: string;