export abstract Class
Collector ​
extends ​
EventEmitter
Constructor ​
ts
new Collector( client, options )| Parameter | Type | Description |
|---|---|---|
client | Client | |
options | Collector.O |
Properties ​
get endReason : undefined | string ​
get next : Promise<Message> ​
readonly client : Client ​
collection : Collection<Collector.I, any> ​
ended : boolean ​
filter : CollectorFilter ​
options : Collector.O ​
Methods ​
asyncIterator ​
Returns: AsyncGenerator<unknown, void, unknown>
checkEnd( ) ​
Returns: boolean
collect( collect ) ​
| Parameter | Type | Description |
|---|---|---|
collect | Collector.C |
Returns: null | Collector.I
dispose( dispose ) ​
| Parameter | Type | Description |
|---|---|---|
dispose | Collector.C |
Returns: null | Collector.I
asynchandleCollect( collect ) ​
| Parameter | Type | Description |
|---|---|---|
collect | Collector.C |
Returns: Promise<void>
asynchandleDispose( dispose ) ​
| Parameter | Type | Description |
|---|---|---|
dispose | Collector.C |
Returns: Promise<void>
stop( reason ) ​
| Parameter | Type | Description |
|---|---|---|
reason = 'user' | string |
Returns: void