Fix Comment Type and Change iterationHelper as a private member

Author: muthurathinam-m

lib/src/tasks/PageIterator.d.ts

@@ -52,10 +52,11 @@ export declare class PageIterator {
      */
     constructor(client: Client, pageCollection: PageCollection, callback: PageIteratorCallback);
     /**
+     * @private
      * Iterates over a collection by enqueuing entries one by one and kicking the callback with the enqueued entry
      * @return A boolean indicating the continue flag to process next page
      */
-    iterationHelper(): boolean;
+    private iterationHelper;
     /**
      * @private
      * @async
@@ -72,7 +73,7 @@ export declare class PageIterator {
     iterate(): Promise<any>;
     /**
      * @async
-     * This internally calls the iterate method, Its juts for more readability.
+     * This internally calls the iterate method, It's just for more readability.
      * @return A Promise that resolves to nothing on completion and throws error incase of any discrepancy
      */
     resume(): Promise<any>;

lib/src/tasks/PageIterator.js

@@ -69,32 +69,24 @@ describe("Constructor", function () {
     });
 });
 
-describe("iterationHelper", function() {
-    it("Should iterate over complete collection", () => {
+describe("iterate", function() {
+    it("Should iterate over a complete collection without nextLink", async () => {
         truthyCallbackCounter = 10;
         let pageIterator = new PageIterator(client, getPageCollection(), truthyCallbackWithCounter);
-        assert.isTrue(pageIterator.iterationHelper());
-        assert.equal(truthyCallbackCounter, 0);
-    });
-
-    it("Should break in the middle of the iteration, this is done by returning red flag from the callback", () => {
-        halfWayCallbackCounter = 5;
-        let pageIterator = new PageIterator(client, getPageCollection(), halfWayCallback);
-        assert.isFalse(pageIterator.iterationHelper());
-        assert.equal(halfWayCallbackCounter, 0);
+        try {
+            await pageIterator.iterate();
+            assert.equal(truthyCallbackCounter, 0);
+        } catch (error) {
+            throw error;
+        }
     });
 
-    it("Should return false for iterating over empty collection", () => {
+    it("Should not iterate over an empty collection", async () => {
         let pageIterator = new PageIterator(client, getEmptyPageCollection(), truthyCallback);
-        assert.isFalse(pageIterator.iterationHelper());
-    });
-});
-
-describe("iterate", function() {
-    it("Should iterate over a complete collection without nextLink", async () => {
-        let pageIterator = new PageIterator(client, getPageCollection(), truthyCallback);
+        halfWayCallbackCounter = 1;
         try {
             await pageIterator.iterate();
+            assert.equal(halfWayCallbackCounter, 1);
         } catch (error) {
             throw error;
         }
@@ -126,4 +118,4 @@ describe("resume", function() {
             throw error;
         }
     });
-});
+});

lib/src/tasks/PageIterator.js.map

@@ -69,10 +69,11 @@ export class PageIterator {
     }
 
     /**
+     * @private
      * Iterates over a collection by enqueuing entries one by one and kicking the callback with the enqueued entry
      * @return A boolean indicating the continue flag to process next page
      */
-    iterationHelper(): boolean {
+    private iterationHelper(): boolean {
         let self = this;
         if (self.collection === undefined || self.collection.length === 0) {
             return false;
@@ -127,7 +128,7 @@ export class PageIterator {
 
     /**
      * @async
-     * This internally calls the iterate method, Its juts for more readability.
+     * This internally calls the iterate method, It's just for more readability.
      * @return A Promise that resolves to nothing on completion and throws error incase of any discrepancy
      */
     async resume(): Promise<any> {