mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-11 00:53:31 +01:00
docs(Collector): properly document endReason (#6016)
This commit is contained in:
@@ -264,6 +264,14 @@ class Collector extends EventEmitter {
|
||||
}
|
||||
|
||||
/* eslint-disable no-empty-function */
|
||||
/**
|
||||
* The reason this collector has ended with, or null if it hasn't ended yet
|
||||
* @type {?string}
|
||||
* @readonly
|
||||
* @abstract
|
||||
*/
|
||||
get endReason() {}
|
||||
|
||||
/**
|
||||
* Handles incoming events from the `handleCollect` function. Returns null if the event should not
|
||||
* be collected, or returns an object describing the data that should be stored.
|
||||
@@ -284,13 +292,6 @@ class Collector extends EventEmitter {
|
||||
*/
|
||||
dispose() {}
|
||||
/* eslint-enable no-empty-function */
|
||||
|
||||
/**
|
||||
* The reason this collector has ended with, or null if it hasn't ended yet
|
||||
* @name Collector#endReason
|
||||
* @type {?string}
|
||||
* @abstract
|
||||
*/
|
||||
}
|
||||
|
||||
module.exports = Collector;
|
||||
|
||||
Reference in New Issue
Block a user