Class StructureCollector<T, R, I>

The base structure collector for asynchronously collecting values.

since: 0.0.1

Type parameters

T: Structure
R: [T, unknown]
I: EventIterator<R>

Hierarchy

StructureCollector
- ReactionCollector
- MessageCollector

Index

Constructors

constructor

Properties

Methods

collect

Constructors

constructor

new StructureCollector(iterator: I): StructureCollector

- Defined in src/lib/util/collectors/base/StructureCollector.ts:22
since

0.0.1

Parameters
- iterator: I
  
  The EventIterator that is yielding values.
Returns StructureCollector

Properties

Private #iterator

#iterator: I

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

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

Generated using TypeDoc