Merge "[FAB-15579] Fix doc for CommonIterator.next()"

hyperledger · Jun 20, 2019 · cd5ed8f · cd5ed8f
2 parents 167b53d + f09bb43
commit cd5ed8f
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/fabric-shim/lib/iterators.js b/fabric-shim/lib/iterators.js
@@ -72,11 +72,11 @@ class CommonIterator {
     }
 
     /**
-	 * Get the next value and return it through a promise and also emit
-	 * it if event listeners have been registered.
+	 * Get the next value and return it through a promise.
 	 * @async
-	 * @return {promise} a promise that is fulfilled with the next value or
-	 * is rejected otherwise
+	 * @return {promise} a promise that is fulfilled with an object { value: (next value) },
+	 * is fulfilled with an object { done: true } if there is no more value,
+	 * or is rejected if any error occurs.
 	 */
     async next() {
         // check to see if there are some results left in the current result set