Preview environment

class MessageCollector

export class MessageCollector extends Collector<Snowflake, Message, [Collection<Snowflake, Message>]>

Collects messages on a channel. Will automatically stop if the channel (channelDelete), thread (threadDelete), or guild (guildDelete) is deleted.

Constructors

constructor(
channel: TextBasedChannel
options?: MessageCollectorOptions
)

channel : TextBasedChannel

The channel

readonly
client : Client

The client that instantiated this Collector

Inherited from: Collector

collected : Collection<Snowflake, Message>

The items collected by this collector

Inherited from: Collector

ended : boolean

Whether this collector has finished collecting

Inherited from: Collector

readonly
endReason : string | null

The reason this collector has ended with, or null if it hasn't ended yet

Inherited from: Collector

filter : CollectorFilter<[Message, ...[]>

The filter applied to this collector

Inherited from: Collector

readonly
lastCollectedAt : Date | null

The Date at which this collector last collected an item

Inherited from: Collector

lastCollectedTimestamp : number | null

The timestamp at which this collector last collected an item

Inherited from: Collector

protected
listener : (...args: any[]) => void

Inherited from: Collector

readonly
next : Promise<Message>

Returns a promise that resolves with the next collected element; rejects with collected elements if the collector finishes without receiving a next element

Inherited from: Collector

options : MessageCollectorOptions

The options of this collector

received : number

Total number of messages that were received in the channel during message collection

[Symbol.asyncIterator]() : AsyncIterableIterator<[Message, ...[]>

Inherited from: Collector

checkEnd() : boolean

Checks whether the collector should end, and if so, ends it.

Returns: Whether the collector ended or not

Inherited from: Collector

collect(
message: Message
) : Snowflake | null

Handles a message for possible collection.

dispose(
message: Message
) : Snowflake | null

Handles a message for possible disposal.

handleCollect(
...args: unknown[]
) : Promise<void>

Call this to handle an event as a collectable element. Accepts any event data as parameters.

Inherited from: Collector

handleDispose(
...args: unknown[]
) : Promise<void>

Call this to remove an element from the collection. Accepts any event data as parameters.

Inherited from: Collector

on<

EventKey extends keyof CollectorEventTypes<Snowflake, Message, [>

>(
event: EventKey
listener: (...args: CollectorEventTypes<Snowflake, Message, [>[EventKey]) => void
) : this

Inherited from: Collector

once<

EventKey extends keyof CollectorEventTypes<Snowflake, Message, [>

>(
event: EventKey
listener: (...args: CollectorEventTypes<Snowflake, Message, [>[EventKey]) => void
) : this

Inherited from: Collector

resetTimer(
options?: CollectorResetTimerOptions
) : void

Resets the collector's timeout and idle timer.

Inherited from: Collector

stop(
reason?: string
) : void

Stops this collector and emits the end event.

Inherited from: Collector

toJSON() : unknown

Inherited from: Collector

collect(
message: Message
)

Emitted whenever a message is collected.

dispose(
message: Message
)

Emitted whenever a message is disposed of.

end(
collected: Collection
reason: string
)

Emitted when the collector is finished collecting.

ignore(
args: any
)

Emitted whenever an element is not collected by the collector.