Collection subclasses code comments [nocode]

overlookmotel · Apr 13, 2021 · 24acfdd · 24acfdd
1 parent 10cd32e
commit 24acfdd
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/lib/all.js b/lib/all.js
@@ -12,6 +12,11 @@ const Collection = require('./collection.js'),
 // Exports
 
 class CollectionAll extends Collection {
+	/**
+	 * Completes on first rejection.
+	 * @param {number} status - `RESOLVED` or `REJECTED`
+	 * @returns {boolean}
+	 */
 	resolveOrRejectCompletes(status) { // eslint-disable-line class-methods-use-this
 		return status === REJECTED;
 	}

diff --git a/lib/allSettled.js b/lib/allSettled.js
@@ -12,6 +12,10 @@ const Collection = require('./collection.js'),
 // Exports
 
 class CollectionAllSettled extends Collection {
+	/**
+	 * Never completes until all are resolved/rejected.
+	 * @returns {boolean}
+	 */
 	resolveOrRejectCompletes() { // eslint-disable-line class-methods-use-this
 		return false;
 	}

diff --git a/lib/any.js b/lib/any.js
@@ -14,6 +14,11 @@ const Collection = require('./collection.js'),
 const AggregateErr = createAggregateErrorClass();
 
 class CollectionAny extends Collection {
+	/**
+	 * Completes on first resolution.
+	 * @param {number} status - `RESOLVED` or `REJECTED`
+	 * @returns {boolean}
+	 */
 	resolveOrRejectCompletes(status) { // eslint-disable-line class-methods-use-this
 		return status === RESOLVED;
 	}

diff --git a/lib/race.js b/lib/race.js
@@ -12,6 +12,10 @@ const Collection = require('./collection.js'),
 // Exports
 
 class CollectionRace extends Collection {
+	/**
+	 * Completes on first resolution or rejection.
+	 * @returns {boolean}
+	 */
 	resolveOrRejectCompletes() { // eslint-disable-line class-methods-use-this
 		return true;
 	}