Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-19 04:53:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(ReactionCollector): Revise JSDoc for ReactionCollector#dispose and #remove (#4709)

Browse Source 
Co-authored-by: Amish Shah <amishshah.2k@gmail.com>
Co-authored-by: uhKevinMC <plainkevin123@gmail.com>
Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com>
Co-authored-by: Antonio Román <kyradiscord@gmail.com>
Co-authored-by: Noel <icrawltogo@gmail.com>
This commit is contained in:
Quentin
2020-09-08 02:57:39 -05:00
committed by GitHub
parent dfd63bdb6b
commit 372a405926
1 changed files with 2 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/structures/ReactionCollector.js
View File

@@ -103,7 +103,7 @@ class ReactionCollector extends Collector {
*/ */
dispose(reaction, user) { dispose(reaction, user) {
/** /**
* Emitted whenever a reaction is disposed of and the `dispose` option is set to true. * Emitted when the reaction had all the users removed and the `dispose` option is set to true.
* @event ReactionCollector#dispose * @event ReactionCollector#dispose
* @param {MessageReaction} reaction The reaction that was disposed of * @param {MessageReaction} reaction The reaction that was disposed of
* @param {User} user The user that removed the reaction * @param {User} user The user that removed the reaction
@@ -111,9 +111,7 @@ class ReactionCollector extends Collector {
if (reaction.message.id !== this.message.id) return null; if (reaction.message.id !== this.message.id) return null;
/** /**
* Emitted whenever a reaction is removed from a message and the `dispose` option is set to true. * Emitted when the reaction had one user removed and the `dispose` option is set to true.
* Will emit on all reaction removals, as opposed to {@link Collector#dispose} which will only
* be emitted when the entire reaction is removed.
* @event ReactionCollector#remove * @event ReactionCollector#remove
* @param {MessageReaction} reaction The reaction that was removed * @param {MessageReaction} reaction The reaction that was removed
* @param {User} user The user that removed the reaction * @param {User} user The user that removed the reaction