feat: add a helper to get the first item from a Listing

ekrzeptowski · May 14, 2021 · 61e8e35 · 61e8e35
1 parent 87a53b0
commit 61e8e35
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/src/listings/listing.ts b/src/listings/listing.ts
@@ -209,6 +209,20 @@ export default class Listing<T> {
     return false;
   }
 
+  /**
+   * Get the first item of this listing.
+   *
+   * @returns A promise that resolves to either the first item of the listing,
+   * or `null` if the listing is empty.
+   */
+  async first(): Promise<T | null> {
+    for await (const el of this) {
+      return el;
+    }
+
+    return null;
+  }
+
   private static async nextPage<T>(
     page: Listing<T>,
     ctx: Context