feat: 🎸 define .scan() CRUD method

streamich · Apr 27, 2024 · 921e05d · 921e05d
1 parent 577ee35
commit 921e05d
Showing 1 changed file with 8 additions and 5 deletions.
diff --git a/src/crud/types.ts b/src/crud/types.ts
@@ -46,6 +46,14 @@ export interface CrudApi {
    */
   drop: (collection: CrudCollection, silent?: boolean) => Promise<void>;
 
+  /**
+   * Iterates over all resources of a collection.
+   *
+   * @param collection Type of the resource, collection name.
+   * @returns Iterator of resources of the given type.
+   */
+  scan: (collection: CrudCollection) => AsyncIterableIterator<CrudCollectionEntry>;
+
   /**
    * Fetches a list of resources of a collection, and sub-collections.
    *
@@ -84,8 +92,3 @@ export interface CrudResourceInfo extends CrudCollectionEntry {
   /** Timestamp when the resource was created. */
   created?: number;
 }
-
-export interface CrudScanResult {
-  cursor: string | '';
-  list: CrudCollectionEntry[];
-}