discord.js | MessageCollector

Search...

MessageCollector

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

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.

Extends

Collector<Snowflake, Message, [Collection<Snowflake, Message>]>

constructor(channel, options?)

Name	Type	Optional	Description
channel	TextBasedChannel	No	None
options	MessageCollectorOptions	Yes	None

collect

Emitted whenever a message is collected.

Name	Type	Optional	Description
message	Message	No	The message that was collected

dispose

Emitted whenever a message is disposed of.

Name	Type	Optional	Description
message	Message	No	The message that was disposed of

end

Emitted when the collector is finished collecting.

Name	Type	Optional	Description
collected	Collection	No	The elements collected by the collector
reason	string	No	The reason the collector ended

ignore

Emitted whenever an element is not collected by the collector.

Name	Type	Optional	Description
args	any	No	The arguments emitted by the listener

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, ...[]>

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):Snowflake | null

Handles a message for possible collection.

Returns

Name	Type	Optional	Description
message	Message	No	The message that could be collected

dispose(message):Snowflake | null

Handles a message for possible disposal.

Returns

Name	Type	Optional	Description
message	Message	No	The message that could be disposed of

handleCollect(...args):Promise<void>

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

Name	Type	Optional	Description
...args	unknown[]	No	The arguments emitted by the listener

Inherited from Collector

handleDispose(...args):Promise<void>

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

Name	Type	Optional	Description
...args	unknown[]	No	The arguments emitted by the listener

Inherited from Collector

on(event, listener):this

Name	Constraints	Optional	Default	Description
EventKey	keyof CollectorEventTypes<Snowflake, Message, [>	No		None

Name	Type	Optional	Description
event	EventKey	No	None
listener	(...args: CollectorEventTypes<Snowflake, Message, [>[EventKey]) => void	No	None

Inherited from Collector

once(event, listener):this

Name	Constraints	Optional	Default	Description
EventKey	keyof CollectorEventTypes<Snowflake, Message, [>	No		None

Name	Type	Optional	Description
event	EventKey	No	None
listener	(...args: CollectorEventTypes<Snowflake, Message, [>[EventKey]) => void	No	None

Inherited from Collector

resetTimer(options?):void

Resets the collector's timeout and idle timer.

Name	Type	Optional	Description
options	CollectorResetTimerOptions	Yes	Options for resetting

Inherited from Collector

stop(reason?):void

Stops this collector and emits the end event.

Name	Type	Optional	Description
reason	string	Yes	The reason this collector is ending

Inherited from Collector

toJSON():unknown