Skip to main content

Interface: AwaitMessagesOptions

Options to be applied to the collector.

Extends

Properties

dispose?

optional dispose: boolean

Whether to dispose data when it's deleted

Inherited from

CollectorOptions.dispose


errors?

optional errors: string[]

An array of "reasons" that would result in the awaitMessages command to throw an error.


idle?

optional idle: number

Max time allowed idle

Inherited from

CollectorOptions.idle


max?

optional max: number

The maximum amount of items to collect

Inherited from

CollectorOptions.max


maxProcessed?

optional maxProcessed: number

The maximum amount of items to process

Inherited from

CollectorOptions.maxProcessed


time?

optional time: number

Max time to wait for items in milliseconds

Inherited from

CollectorOptions.time