Interface: MessageCollectorOptions

Options to be passed to a MessageCollector

Extends

• CollectorOptions<Message>

Properties

dispose?

optional dispose?: boolean

Whether to dispose data when it's deleted

Inherited from

CollectorOptions.dispose

---

filter?

optional filter?: (item, ...args) => boolean

The filter applied to this collector

Parameters

Parameter	Type
item	Message
...args	any[]

Returns

boolean

Inherited from

CollectorOptions.filter

---

idle?

optional idle?: number

How long to stop the collector after inactivity in milliseconds

Inherited from

CollectorOptions.idle

---

max?

optional max?: number

The maximum number of messages to collect

---

maxProcessed?

optional maxProcessed?: number

The maximum number of messages to process (both matching and non-matching the filter)

---

time?

optional time?: number

How long to run the collector for in milliseconds

Inherited from

CollectorOptions.time