feat: add a way to execute a function on each page of a listing

src/listings/listing.ts

@@ -114,7 +114,7 @@ export default class Listing<T> {
   }
 
   /**
-   * Execute a function on each element of the listing.
+   * Execute a function on pages of the listing.
    *
    * If the function returns or resolves to `false`, the execution will be
    * halted prematurely to allow breaking out in the middle of the iteration.
@@ -123,15 +123,13 @@ export default class Listing<T> {
    *
    * @returns A promise that resolves when the listing has been exausted.
    */
-  async each(fn: Awaitable<T, boolean | void>): Promise<void> {
+  async eachPage(fn: Awaitable<T[], boolean | void>): Promise<void> {
     let page: Listing<T> | null = this;
 
     do {
-      for (const el of page.arr) {
-        // If the function returns false at any point, we are done.
-        const res = await fn(el);
-        if (res === false) return;
-      }
+      // If the function returns false at any point, we are done.
+      const res = await fn(page.arr);
+      if (res === false) return;
 
       if (page.next) {
         page = page.next;
@@ -142,4 +140,25 @@ export default class Listing<T> {
       }
     } while (page != null);
   }
+
+  /**
+   * Execute a function on each element of the listing.
+   *
+   * If the function returns or resolves to `false`, the execution will be
+   * halted prematurely to allow breaking out in the middle of the iteration.
+   *
+   * @param fn The function to execute.
+   *
+   * @returns A promise that resolves when the listing has been exausted.
+   */
+  async each(fn: Awaitable<T, boolean | void>): Promise<void> {
+    await this.eachPage(async page => {
+      for (const el of page) {
+        // If the function returns false at any point, we are done.
+        const res = await fn(el);
+        if (res === false) return false;
+      }
+      return true;
+    });
+  }
 }