@onyx.dev/onyx-database 0.1.6 → 0.1.9

package/dist/index.d.cts

@@ -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`
@@ -444,10 +458,10 @@ interface IQueryBuilder<T = unknown> {
      * Selects a subset of fields to return.
      * @example
      * ```ts
-     * const emails = await db.from('User').selectFields('email').list();
+     * const emails = await db.from('User').select('email').list();
      * ```
      */
-    selectFields(...fields: Array<string | string[]>): IQueryBuilder<T>;
+    select(...fields: Array<string | string[]>): IQueryBuilder<T>;
     /**
      * Resolves related values by name.
      * @example
@@ -503,7 +517,7 @@ interface IQueryBuilder<T = unknown> {
     * Ensures only distinct records are returned.
     * @example
     * ```ts
-     * const roles = await db.from('User').selectFields('role').distinct().list();
+     * const roles = await db.from('User').select('role').distinct().list();
      * ```
      */
     distinct(): IQueryBuilder<T>;

package/dist/index.d.ts

@@ -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`
@@ -444,10 +458,10 @@ interface IQueryBuilder<T = unknown> {
      * Selects a subset of fields to return.
      * @example
      * ```ts
-     * const emails = await db.from('User').selectFields('email').list();
+     * const emails = await db.from('User').select('email').list();
      * ```
      */
-    selectFields(...fields: Array<string | string[]>): IQueryBuilder<T>;
+    select(...fields: Array<string | string[]>): IQueryBuilder<T>;
     /**
      * Resolves related values by name.
      * @example
@@ -503,7 +517,7 @@ interface IQueryBuilder<T = unknown> {
     * Ensures only distinct records are returned.
     * @example
     * ```ts
-     * const roles = await db.from('User').selectFields('role').distinct().list();
+     * const roles = await db.from('User').select('role').distinct().list();
      * ```
      */
     distinct(): IQueryBuilder<T>;

package/dist/index.js

@@ -580,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.
@@ -980,7 +1003,7 @@ var OnyxDatabaseImpl = class {
       null,
       this.defaultPartition
     );
-    qb.selectFields(...fields);
+    qb.select(...fields);
     return qb;
   }
   cascade(...relationships) {
@@ -1187,7 +1210,7 @@ var QueryBuilderImpl = class {
     this.table = table;
     return this;
   }
-  selectFields(...fields) {
+  select(...fields) {
     const flat = fields.flatMap((f) => Array.isArray(f) ? f : [f]);
     this.fields = flat.length > 0 ? flat : null;
     return this;