Class ReactionCollector

The ReactionCollector class responsible for collecting a set of reactions.

since: 0.0.1

Hierarchy

StructureCollector<MessageReaction, [MessageReaction, User], ReactionIterator>
- ReactionCollector

Index

Constructors

constructor

Properties

Methods

collect

Constructors

constructor

new ReactionCollector(message: Message, options: ReactionCollectorOptions): ReactionCollector

Overrides StructureCollector.constructor
- Defined in src/lib/util/collectors/ReactionCollector.ts:35
Construct's a new ReactionCollector.

since

0.0.1

Parameters
- message: Message
  
  The message to listen for reactions.
- options: ReactionCollectorOptions
  
  Any additional options to pass.
Returns ReactionCollector

Properties

Private #iterator

#iterator: ReactionIterator

The event iterator that's yielding values.

since: 0.0.1

Protected collected

collected: Cache<string, T> = new Cache<string, T>()

The collected values.

since: 0.0.1

Methods

collect

collect(): Promise<Cache<string, MessageReaction>>

Inherited from StructureCollector.collect
- Defined in src/lib/util/collectors/base/StructureCollector.ts:36
Collect's the values into the Collector's cache.

since

0.0.1

Returns Promise<Cache<string, MessageReaction>>

Generated using TypeDoc