Class MessageCollector

The MessageCollector class responsible for collecting a set of messages.

since: 0.0.1

Hierarchy

StructureCollector<Message, [Message], MessageIterator>
- MessageCollector

Index

Constructors

constructor

Properties

Methods

collect

Constructors

constructor

new MessageCollector(channel: GuildTextChannel | DMChannel, options: MessageCollectorOptions): MessageCollector

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

since

0.0.1

Parameters
- channel: GuildTextChannel | DMChannel
  
  The channel to listen for messages.
- options: MessageCollectorOptions
  
  Any additional options to pass.
Returns MessageCollector

Properties

Private #iterator

#iterator: MessageIterator

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, Message>>

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, Message>>

Generated using TypeDoc