discord.js | ReactionCollector

Search...

ReactionCollector

export class ReactionCollector extends Collector<Snowflake | string, MessageReaction, [User]>

export class ReactionCollector extends Collector<Snowflake | string, MessageReaction, [User]>

Collects reactions on messages. Will automatically stop if the message (messageDelete or messageDeleteBulk), channel (channelDelete), thread (threadDelete), or guild (guildDelete) is deleted.

Extends

Collector<Snowflake | string, MessageReaction, [User]>

constructor(message, options?)

Name	Type	Optional	Description
message	Message	No	None
options	ReactionCollectorOptions	Yes	None

collect

Emitted whenever a reaction is collected.

Name	Type	Optional	Description
reaction	MessageReaction	No	The reaction that was collected
user	User	No	The user that added the reaction

create

Emitted whenever a reaction is newly created on a message. Will emit only when a new reaction is added to the message, as opposed to which will be emitted even when a reaction has already been added to the message.

Name	Type	Optional	Description
reaction	MessageReaction	No	The reaction that was added
user	User	No	The user that added the reaction

dispose

Emitted when the reaction had all the users removed and the dispose option is set to true.

Name	Type	Optional	Description
reaction	MessageReaction	No	The reaction that was disposed of
user	User	No	The user that removed the reaction

end

Emitted when the collector is finished collecting.

Name	Type	Optional	Description
collected	Collection	No	The elements collected by the collector
reason	string	No	The reason the collector ended

ignore

Emitted whenever an element is not collected by the collector.

Name	Type	Optional	Description
args	any	No	The arguments emitted by the listener

remove

Emitted when the reaction had one user removed and the dispose option is set to true.

Name	Type	Optional	Description
reaction	MessageReaction	No	The reaction that was removed
user	User	No	The user that removed the reaction

Readonly

client:Client

The client that instantiated this Collector

collected:Collection

The items collected by this collector

ended:boolean

Whether this collector has finished collecting

Readonly

endReason?:string

The reason this collector has ended with, or null if it hasn't ended yet

filter:CollectorFilter

The filter applied to this collector

lastCollectedAt?:Date

The Date at which this collector last collected an item

lastCollectedTimestamp?:number

The timestamp at which this collector last collected an item

Protected

listener:(...args: any[]) => void

Inherited from Collector

message:Message

The message upon which to collect reactions

Readonly

next:Promise

Returns a promise that resolves with the next collected element; rejects with collected elements if the collector finishes without receiving a next element

options:ReactionCollectorOptions

The options of this collector

total:number

The total number of reactions collected

users:Collection<Snowflake, User>

The users that have reacted to this message

[Symbol.asyncIterator]():AsyncIterableIterator<[MessageReaction, ...[]>

checkEnd():boolean

Checks whether the collector should end, and if so, ends it.

Returns

Whether the collector ended or not

Inherited from Collector

collect(reaction, user):Snowflake | string | null

Handles an incoming reaction for possible collection.

Returns

Name	Type	Optional	Description
reaction	MessageReaction	No	The reaction to possibly collect
user	User	No	The user that added the reaction

dispose(reaction, user):Snowflake | string | null

Handles a reaction deletion for possible disposal.

Returns

Name	Type	Optional	Description
reaction	MessageReaction	No	The reaction to possibly dispose of
user	User	No	The user that removed the reaction

empty():void

Empties this reaction collector.

handleCollect(...args):Promise<void>

Call this to handle an event as a collectable element. Accepts any event data as parameters.

Name	Type	Optional	Description
...args	unknown[]	No	The arguments emitted by the listener

Inherited from Collector

handleDispose(...args):Promise<void>

Call this to remove an element from the collection. Accepts any event data as parameters.

Name	Type	Optional	Description
...args	unknown[]	No	The arguments emitted by the listener

Inherited from Collector

Static

key(reaction):Snowflake | string

Gets the collector key for a reaction.

Name	Type	Optional	Description
reaction	MessageReaction	No	The message reaction to get the key for

on(event, listener):this

Name	Type	Optional	Description
event	'collect' \| 'dispose' \| 'remove' \| 'ignore'	No	None
listener	(reaction: MessageReaction, user: User) => void	No	None

once(event, listener):this

Name	Type	Optional	Description
event	'collect' \| 'dispose' \| 'remove' \| 'ignore'	No	None
listener	(reaction: MessageReaction, user: User) => void	No	None

resetTimer(options?):void

Resets the collector's timeout and idle timer.

Name	Type	Optional	Description
options	CollectorResetTimerOptions	Yes	Options for resetting

Inherited from Collector

stop(reason?):void

Stops this collector and emits the end event.

Name	Type	Optional	Description
reason	string	Yes	The reason this collector is ending

Inherited from Collector

toJSON():unknown