@onyx.dev/onyx-database 0.1.5 → 0.1.7

package/dist/index.d.cts

@@ -202,7 +202,7 @@ declare class QueryResults<T> extends Array<T> {
       * const results = new QueryResults(users, token, t => fetchMore(t));
       * ```
       */
-    constructor(records: T[], nextPage: string | null, fetcher?: (token: string) => Promise<QueryResults<T>>);
+    constructor(records: Iterable<T> | ArrayLike<T> | T | null | undefined, nextPage: string | null, fetcher?: (token: string) => Promise<QueryResults<T>>);
     /**
      * Returns the first record in the result set.
      * @throws Error if the result set is empty.
@@ -239,12 +239,26 @@ declare class QueryResults<T> extends Array<T> {
     /**
      * Iterates over each record on the current page only.
      * @param action - Function to invoke for each record.
+     * @param thisArg - Optional `this` binding for the callback.
      * @example
      * ```ts
      * results.forEachOnPage(u => console.log(u.id));
      * ```
      */
-    forEachOnPage(action: (item: T) => void): void;
+    forEachOnPage(action: (item: T, index: number, array: QueryResults<T>) => void, thisArg?: unknown): void;
+    /**
+     * Iterates over every record across all pages sequentially.
+     * @param action - Function executed for each record. Returning `false`
+     *                 stops iteration early.
+     * @param thisArg - Optional `this` binding for the callback.
+     * @example
+     * ```ts
+     * await results.forEach(u => {
+     *   console.log(u.id);
+     * });
+     * ```
+     */
+    forEach(action: (item: T, index: number, array: T[]) => void, thisArg?: unknown): Promise<void>;
     /**
      * Iterates over every record across all pages sequentially.
      * @param action - Function executed for each record. Returning `false`

package/dist/index.d.ts

@@ -202,7 +202,7 @@ declare class QueryResults<T> extends Array<T> {
       * const results = new QueryResults(users, token, t => fetchMore(t));
       * ```
       */
-    constructor(records: T[], nextPage: string | null, fetcher?: (token: string) => Promise<QueryResults<T>>);
+    constructor(records: Iterable<T> | ArrayLike<T> | T | null | undefined, nextPage: string | null, fetcher?: (token: string) => Promise<QueryResults<T>>);
     /**
      * Returns the first record in the result set.
      * @throws Error if the result set is empty.
@@ -239,12 +239,26 @@ declare class QueryResults<T> extends Array<T> {
     /**
      * Iterates over each record on the current page only.
      * @param action - Function to invoke for each record.
+     * @param thisArg - Optional `this` binding for the callback.
      * @example
      * ```ts
      * results.forEachOnPage(u => console.log(u.id));
      * ```
      */
-    forEachOnPage(action: (item: T) => void): void;
+    forEachOnPage(action: (item: T, index: number, array: QueryResults<T>) => void, thisArg?: unknown): void;
+    /**
+     * Iterates over every record across all pages sequentially.
+     * @param action - Function executed for each record. Returning `false`
+     *                 stops iteration early.
+     * @param thisArg - Optional `this` binding for the callback.
+     * @example
+     * ```ts
+     * await results.forEach(u => {
+     *   console.log(u.id);
+     * });
+     * ```
+     */
+    forEach(action: (item: T, index: number, array: T[]) => void, thisArg?: unknown): Promise<void>;
     /**
      * Iterates over every record across all pages sequentially.
      * @param action - Function executed for each record. Returning `false`

package/dist/index.js

@@ -519,7 +519,18 @@ var QueryResults = class extends Array {
     * ```
     */
   constructor(records, nextPage, fetcher) {
-    super(...records);
+    const items = (() => {
+      if (records == null) return [];
+      if (Array.isArray(records)) return records;
+      if (typeof records[Symbol.iterator] === "function") {
+        return Array.from(records);
+      }
+      if (typeof records.length === "number") {
+        return Array.from(records);
+      }
+      return [records];
+    })();
+    super(...items);
     Object.setPrototypeOf(this, new.target.prototype);
     this.nextPage = nextPage;
     this.fetcher = fetcher;
@@ -569,13 +580,36 @@ var QueryResults = class extends Array {
   /**
    * Iterates over each record on the current page only.
    * @param action - Function to invoke for each record.
+   * @param thisArg - Optional `this` binding for the callback.
    * @example
    * ```ts
    * results.forEachOnPage(u => console.log(u.id));
    * ```
    */
-  forEachOnPage(action) {
-    this.forEach(action);
+  forEachOnPage(action, thisArg) {
+    super.forEach((value, index) => {
+      action.call(thisArg, value, index, this);
+    });
+  }
+  /**
+   * Iterates over every record across all pages sequentially.
+   * @param action - Function executed for each record. Returning `false`
+   *                 stops iteration early.
+   * @param thisArg - Optional `this` binding for the callback.
+   * @example
+   * ```ts
+   * await results.forEach(u => {
+   *   console.log(u.id);
+   * });
+   * ```
+   */
+  forEach(action, thisArg) {
+    let index = 0;
+    return this.forEachAll(async (item) => {
+      const result = await action.call(thisArg, item, index, this);
+      index += 1;
+      return result;
+    });
   }
   /**
    * Iterates over every record across all pages sequentially.