feat(Collector): return a boolean on checkEnd (#6289)

discordjs · Aug 5, 2021 · f473f43 · f473f43
1 parent b4afcf8
commit f473f43
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/src/structures/interfaces/Collector.js b/src/structures/interfaces/Collector.js
@@ -207,7 +207,6 @@ class Collector extends EventEmitter {
   /**
    * Resets the collector's timeout and idle timer.
    * @param {CollectorResetTimerOptions} [options] Options for reseting
-
    */
   resetTimer({ time, idle } = {}) {
     if (this._timeout) {
@@ -222,10 +221,12 @@ class Collector extends EventEmitter {
 
   /**
    * Checks whether the collector should end, and if so, ends it.
+   * @returns {boolean} Whether the collector ended or not
    */
   checkEnd() {
     const reason = this.endReason;
     if (reason) this.stop(reason);
+    return Boolean(reason);
   }
 
   /**

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -474,7 +474,7 @@ export abstract class Collector<K, V, F extends unknown[] = []> extends EventEmi
   public filter: CollectorFilter<[V, ...F]>;
   public readonly next: Promise<V>;
   public options: CollectorOptions<[V, ...F]>;
-  public checkEnd(): void;
+  public checkEnd(): boolean;
   public handleCollect(...args: unknown[]): Promise<void>;
   public handleDispose(...args: unknown[]): Promise<void>;
   public stop(reason?: string): void;