MessageCollector

Package: @erinjs/core

Collects messages in a channel. Use channel.createMessageCollector().

Constructor

Name	Type	Optional	Description
client	Client	No
channelId	string	No
options	MessageCollectorOptions	No

Properties

Name	Type	Readonly	Optional	Description
channelId	string	Yes	No
client	Client	Yes	No
collected	any	Yes	No
options	Required<MessageCollectorOptions>	Yes	No

Methods

emit()

Returns: boolean

Parameters:

Name	Type	Optional	Description
event	K	No
args	MessageCollectorEvents[K]	No

---

on()

Returns: this

Parameters:

Name	Type	Optional	Description
event	K	No
listener	(...args: MessageCollectorEvents[K]) => void	No

---

stop()

Returns: void

Parameters:

Name	Type	Optional	Description
reason	MessageCollectorEndReason	No