Skip to content

export Class

CallbackCollector ​

extends ​

Collector<CallbackCollectorOptions, string, CallbackQuery>

Constructor ​

ts
new CallbackCollector( message, options )
ParameterTypeDescription
messageMessage
optionsCallbackCollectorOptions

Properties ​

get endReason : undefined | string ​

get next : Promise<Message> ​

readonly client : Client ​

collection : Collection<string, any> ​

ended : boolean ​

filter : CollectorFilter ​

message : Message ​

options : CallbackCollectorOptions ​

received : number ​

Methods ​

asyncIterator ​

Returns: AsyncGenerator<unknown, void, unknown>

checkEnd( ) ​

Returns: boolean

collect( query ) ​

ParameterTypeDescription
queryCallbackQuery

Returns: null | string

dispose( query ) ​

ParameterTypeDescription
queryCallbackQuery

Returns: null | string

asynchandleCollect( collect ) ​

ParameterTypeDescription
collectCallbackQuery

Returns: Promise<void>

asynchandleDispose( dispose ) ​

ParameterTypeDescription
disposeCallbackQuery

Returns: Promise<void>

stop( reason ) ​

ParameterTypeDescription
reason = 'user'string

Returns: void