Class

ReactionCollector

Collects reactions on a message. Use message.createReactionCollector(). Listens to both Events.MessageReactionAdd and Events.MessageReactionAddMany (gateway may batch rapid reactions into ADD_MANY instead of individual ADD events).

Extends EventEmitter

Constructor

new ReactionCollector(client: Client, messageId: string, channelId: string, options: ReactionCollectorOptions)

client: Client
messageId: string
channelId: string
options: ReactionCollectorOptions

Properties

Name	Type	Description
channelIdread-only	`string`
clientread-only	`Client`
collectedread-only	`any`
messageIdread-only	`string`
optionsread-only	`Required<ReactionCollectorOptions>`

Methods

static awaitReactions(client, messageId, channelId, options?)

client: Client, messageId: string, channelId: string, options?: ReactionCollectorOptions & { errors?: ReactionCollectorEndReason[] } → Promise<Collection<string, CollectedReaction>>

One-shot helper used by message.awaitReactions. Resolves with the collected reactions when the collector ends. Rejects if options.errors includes the end reason.

ReactionCollector.awaitReactions(client, messageId, channelId);

.emit(event, args)

event: K, args: ReactionCollectorEvents[K] → boolean

reactionCollector.emit(event, args);

.on(event, listener)

event: K, listener: (...args: ReactionCollectorEvents[K]) => void → this

reactionCollector.on(event, listener);

.stop(reason)

reason: ReactionCollectorEndReason → void

reactionCollector.stop(reason);