From 1833a83664fcf23a970bafd970f675194144183a Mon Sep 17 00:00:00 2001 From: York Date: Thu, 17 Nov 2016 07:18:03 +0000 Subject: [PATCH] Documented reaction events (#905) --- src/client/actions/MessageReactionAdd.js | 7 ++++++- src/client/actions/MessageReactionRemove.js | 7 ++++++- src/client/actions/MessageReactionRemoveAll.js | 6 +++++- 3 files changed, 17 insertions(+), 3 deletions(-) diff --git a/src/client/actions/MessageReactionAdd.js b/src/client/actions/MessageReactionAdd.js index c53af3828..75f4cde5e 100644 --- a/src/client/actions/MessageReactionAdd.js +++ b/src/client/actions/MessageReactionAdd.js @@ -34,5 +34,10 @@ class MessageReactionAdd extends Action { }; } } - +/** + * Emitted whenever a reaction is added to a message. + * @event Client#messageReactionAdd. + * @param {MessageReaction} messageReaction The reaction object. + * @param {User} user The user that applied the emoji or reaction emoji. + */ module.exports = MessageReactionAdd; diff --git a/src/client/actions/MessageReactionRemove.js b/src/client/actions/MessageReactionRemove.js index ae626ea00..ab9cec2bf 100644 --- a/src/client/actions/MessageReactionRemove.js +++ b/src/client/actions/MessageReactionRemove.js @@ -34,5 +34,10 @@ class MessageReactionRemove extends Action { }; } } - +/** + * Emitted whenever a reaction is removed from a message. + * @event Client#messageReactionRemove. + * @param {MessageReaction} messageReaction The reaction object. + * @param {User} user The user that removed the emoji or reaction emoji. + */ module.exports = MessageReactionRemove; diff --git a/src/client/actions/MessageReactionRemoveAll.js b/src/client/actions/MessageReactionRemoveAll.js index 54f38a6c4..3aefe69f1 100644 --- a/src/client/actions/MessageReactionRemoveAll.js +++ b/src/client/actions/MessageReactionRemoveAll.js @@ -17,5 +17,9 @@ class MessageReactionRemoveAll extends Action { }; } } - +/** + * Emitted whenever all reactions are removed from a message. + * @event Client#messageReactionRemoveAll. + * @param {MessageReaction} messageReaction The reaction object. + */ module.exports = MessageReactionRemoveAll;