Preview environment

interface AwaitMessagesOptions

export interface AwaitMessagesOptions extends MessageCollectorOptions

An object containing the same properties as CollectorOptions, but a few more:

optional
dispose? : boolean

Whether to dispose data when it's deleted

Inherited from: CollectorOptions

optional
errors? : readonly string[]

Stop/end reasons that cause the promise to reject

optional
filter? : CollectorFilter<FilterArguments>

The filter applied to this collector

Inherited from: CollectorOptions

optional
idle? : number

How long to stop the collector after inactivity in milliseconds

Inherited from: CollectorOptions

optional
max? : number

The maximum amount of messages to collect

Inherited from: MessageCollectorOptions

optional
maxProcessed? : number

The maximum amount of messages to process

Inherited from: MessageCollectorOptions

optional
time? : number

How long to run the collector for in milliseconds

Inherited from: CollectorOptions