Fix types for Message.reactions (#1068)

abalabahaha · Nov 29, 2020 · 592313d · 592313d
1 parent aca342e
commit 592313d
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 4 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1932,7 +1932,7 @@ declare namespace Eris {
     messageReference: MessageReference | null;
     pinned: boolean;
     prefix?: string;
-    reactions: { [s: string]: unknown; count: number; me: boolean };
+    reactions: { [s: string]: { count: number; me: boolean } };
     roleMentions: string[];
     timestamp: number;
     tts: boolean;

diff --git a/lib/structures/Message.js b/lib/structures/Message.js
@@ -33,9 +33,7 @@ const User = require("./User");
 * @prop {String} messageReference.guildID The id of the guild this message was crossposted from
 * @prop {Boolean} pinned Whether the message is pinned or not
 * @prop {String?} prefix The prefix used in the Message, if any (CommandClient only)
-* @prop {Object} reactions An object containing the reactions on the message
-* @prop {Boolean} reactions.me Whether or not the bot user did the reaction
-* @prop {Number} reactions.count The number of times the reaction was used
+* @prop {Object} reactions An object containing the reactions on the message. Each key is a reaction emoji and each value is an object with properties `me` (Boolean) and `count` (Number) for that specific reaction emoji.
 * @prop {Array<String>} roleMentions Array of mentioned roles' ids
 * @prop {Number} timestamp Timestamp of message creation
 * @prop {Boolean} tts Whether to play the message using TTS or not