Skip to content

ComponentCollectorOptions

Defined in: packages/structures/src/index.ts:12

Options for Message.createComponentCollector.

optional componentType?: number

Defined in: packages/structures/src/index.ts:14

Only this component type (2 button, 3 string select…).


optional filter?: (item) => boolean | Promise<boolean>

Defined in: packages/core/src/collector.ts:5

Filter predicate to accept or reject items.

ComponentInteraction

boolean | Promise<boolean>

CollectorOptions.filter


optional idle?: number

Defined in: packages/core/src/collector.ts:13

Stop after this many milliseconds without a collected item.

CollectorOptions.idle


optional max?: number

Defined in: packages/core/src/collector.ts:9

Maximum number of elements to collect.

CollectorOptions.max


optional maxProcessed?: number

Defined in: packages/core/src/collector.ts:11

Maximum number of processed elements.

CollectorOptions.maxProcessed


optional signal?: AbortSignal

Defined in: packages/core/src/collector.ts:15

Stop (reason "abort") when this signal aborts.

CollectorOptions.signal


optional time?: number

Defined in: packages/core/src/collector.ts:7

Lifetime of the collector in milliseconds.

CollectorOptions.time