refactor(Collector): make endReason a getter (#5271)

This commit is contained in:
Jan
2021-03-28 15:29:39 +02:00
committed by GitHub
parent 09846c725b
commit 8d14ee3540
4 changed files with 11 additions and 16 deletions

View File

@@ -214,7 +214,7 @@ class Collector extends EventEmitter {
* Checks whether the collector should end, and if so, ends it.
*/
checkEnd() {
const reason = this.endReason();
const reason = this.endReason;
if (reason) this.stop(reason);
}
@@ -253,7 +253,7 @@ class Collector extends EventEmitter {
return Util.flatten(this);
}
/* eslint-disable no-empty-function, valid-jsdoc */
/* eslint-disable no-empty-function */
/**
* 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.
@@ -273,14 +273,14 @@ class Collector extends EventEmitter {
* @abstract
*/
dispose() {}
/* eslint-enable no-empty-function */
/**
* The reason this collector has ended or will end with.
* @returns {?string} Reason to end the collector, if any
* The reason this collector has ended with, or null if it hasn't ended yet
* @name Collector#endReason
* @type {?string}
* @abstract
*/
endReason() {}
/* eslint-enable no-empty-function, valid-jsdoc */
}
module.exports = Collector;