Class ReactionCollector

A collector that collects reactions on messages

Hierarchy

Collector<MessageReaction>
- ReactionCollector

Index

Constructors

Properties

boundItemReceiver client emitter entries isActive maxTimeout options resolve

Methods

_cleanup decrementMaxEventListeners hookEvents incrementMaxEventListeners itemReceived start

Constructors

constructor

new ReactionCollector(client, options): ReactionCollector
Parameters
- client: Client
- options: Partial<CollectorOptions<MessageReaction>>
Returns ReactionCollector
Inherited from Collector.constructor
- Defined in guilded.js/lib/structures/collectors/Collector.ts:30

Properties

`Protected` boundItemReceiver

boundItemReceiver: ((entry) => Promise<boolean>) = ...

Type declaration

- (entry): Promise<boolean>
- Bound function for item receiving
  Parameters
  - entry: MessageReaction
  Returns Promise<boolean>

`Readonly` client

client: Client

emitter

emitter: TypedEventEmitter<CollectorEvents<MessageReaction>> = ...

`Readonly` entries

entries: Collection<string, MessageReaction> = ...

Collection of successfully collected entries

isActive

isActive: boolean = false

Whether the collector is actively collecting elements

`Protected` maxTimeout

maxTimeout: null | Timeout = null

Timeout for max time

options

options: Partial<CollectorOptions<MessageReaction>>

`Protected` resolve

resolve: null | ((value) => void) = null

Method to resolve the promise this collector has when instantiated

Methods

_cleanup

_cleanup(): void
Cleans up events and listeners after the collector has stopped collecting

Returns void
Overrides Collector._cleanup
- Defined in guilded.js/lib/structures/collectors/ReactionCollector.ts:21

`Protected` decrementMaxEventListeners

decrementMaxEventListeners(): number
Decrement the max number of event listeners for the client

Returns number
The new max number of event listeners for the client
Inherited from Collector.decrementMaxEventListeners
- Defined in guilded.js/lib/structures/collectors/Collector.ts:106

hookEvents

hookEvents(): void
Hooks the necessary events to start collecting reactions

Returns void
Overrides Collector.hookEvents
- Defined in guilded.js/lib/structures/collectors/ReactionCollector.ts:13

`Protected` incrementMaxEventListeners

incrementMaxEventListeners(): number
Increment the max number of event listeners for the client

Returns number
The new max number of event listeners for the client
Inherited from Collector.incrementMaxEventListeners
- Defined in guilded.js/lib/structures/collectors/Collector.ts:95

itemReceived

itemReceived(entry): Promise<boolean>
Receives an item
Parameters
- entry: MessageReaction
  
  The item received
Returns Promise<boolean>
Whether the item passes the filter function or not
Inherited from Collector.itemReceived
- Defined in guilded.js/lib/structures/collectors/Collector.ts:67

start

start(): Promise<CollectorReturnValue<MessageReaction>>
Start the collector

Returns Promise<CollectorReturnValue<MessageReaction>>
A promise that resolves with a CollectorReturnValue object
Inherited from Collector.start
- Defined in guilded.js/lib/structures/collectors/Collector.ts:43

Generated using TypeDoc