@mikro-orm/core 6.4.12-dev.0 → 6.4.12-dev.10

package/EntityManager.d.ts

@@ -165,6 +165,10 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
      * });
      * ```
      *
+     * The options also support an `includeCount` (true by default) option. If set to false, the `totalCount` is not
+     * returned as part of the cursor. This is useful for performance reason, when you don't care about the total number
+     * of pages.
+     *
      * The `Cursor` object provides the following interface:
      *
      * ```ts
@@ -174,7 +178,7 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
      *     User { ... },
      *     User { ... },
      *   ],
-     *   totalCount: 50,
+     *   totalCount: 50, // not included if `includeCount: false`
      *   startCursor: 'WzRd',
      *   endCursor: 'WzZd',
      *   hasPrevPage: true,
@@ -182,7 +186,7 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
      * }
      * ```
      */
-    findByCursor<Entity extends object, Hint extends string = never, Fields extends string = '*', Excludes extends string = never>(entityName: EntityName<Entity>, where: FilterQuery<NoInfer<Entity>>, options: FindByCursorOptions<Entity, Hint, Fields, Excludes>): Promise<Cursor<Entity, Hint, Fields, Excludes>>;
+    findByCursor<Entity extends object, Hint extends string = never, Fields extends string = '*', Excludes extends string = never, IncludeCount extends boolean = true>(entityName: EntityName<Entity>, where: FilterQuery<NoInfer<Entity>>, options: FindByCursorOptions<Entity, Hint, Fields, Excludes, IncludeCount>): Promise<Cursor<Entity, Hint, Fields, Excludes, IncludeCount>>;
     /**
      * Refreshes the persistent state of an entity from the database, overriding any local changes that have not yet been
      * persisted. Returns the same entity instance (same object reference), but re-hydrated. If the entity is no longer

package/EntityManager.js

@@ -426,6 +426,10 @@ class EntityManager {
      * });
      * ```
      *
+     * The options also support an `includeCount` (true by default) option. If set to false, the `totalCount` is not
+     * returned as part of the cursor. This is useful for performance reason, when you don't care about the total number
+     * of pages.
+     *
      * The `Cursor` object provides the following interface:
      *
      * ```ts
@@ -435,7 +439,7 @@ class EntityManager {
      *     User { ... },
      *     User { ... },
      *   ],
-     *   totalCount: 50,
+     *   totalCount: 50, // not included if `includeCount: false`
      *   startCursor: 'WzRd',
      *   endCursor: 'WzZd',
      *   hasPrevPage: true,
@@ -450,7 +454,9 @@ class EntityManager {
         if (utils_1.Utils.isEmpty(options.orderBy)) {
             throw new Error('Explicit `orderBy` option required');
         }
-        const [entities, count] = await em.findAndCount(entityName, where, options);
+        const [entities, count] = options.includeCount !== false
+            ? await em.findAndCount(entityName, where, options)
+            : [await em.find(entityName, where, options)];
         return new utils_1.Cursor(entities, count, options, this.metadata.get(entityName));
     }
     /**

package/drivers/IDatabaseDriver.d.ts

@@ -149,7 +149,8 @@ export interface FindOptions<Entity, Hint extends string = never, Fields extends
     /** @internal used to apply filters to the auto-joined relations */
     em?: EntityManager;
 }
-export interface FindByCursorOptions<T extends object, P extends string = never, F extends string = '*', E extends string = never> extends Omit<FindOptions<T, P, F, E>, 'limit' | 'offset'> {
+export interface FindByCursorOptions<T extends object, P extends string = never, F extends string = '*', E extends string = never, I extends boolean = true> extends Omit<FindOptions<T, P, F, E>, 'limit' | 'offset'> {
+    includeCount?: I;
 }
 export interface FindOneOptions<T extends object, P extends string = never, F extends string = '*', E extends string = never> extends Omit<FindOptions<T, P, F, E>, 'limit' | 'lockMode'> {
     lockMode?: LockMode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/core",
-  "version": "6.4.12-dev.0",
+  "version": "6.4.12-dev.10",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "index.js",
   "module": "index.mjs",
@@ -64,7 +64,7 @@
     "esprima": "4.0.1",
     "fs-extra": "11.3.0",
     "globby": "11.1.0",
-    "mikro-orm": "6.4.12-dev.0",
+    "mikro-orm": "6.4.12-dev.10",
     "reflect-metadata": "0.2.2"
   }
 }

package/utils/Cursor.d.ts

@@ -49,13 +49,13 @@ import { type QueryOrder } from '../enums';
  * }
  * ```
  */
-export declare class Cursor<Entity extends object, Hint extends string = never, Fields extends string = '*', Excludes extends string = never> {
+export declare class Cursor<Entity extends object, Hint extends string = never, Fields extends string = '*', Excludes extends string = never, IncludeCount extends boolean = true> {
     readonly items: Loaded<Entity, Hint, Fields, Excludes>[];
-    readonly totalCount: number;
+    readonly totalCount: IncludeCount extends true ? number : undefined;
     readonly hasPrevPage: boolean;
     readonly hasNextPage: boolean;
     private readonly definition;
-    constructor(items: Loaded<Entity, Hint, Fields, Excludes>[], totalCount: number, options: FindByCursorOptions<Entity, Hint, Fields, Excludes>, meta: EntityMetadata<Entity>);
+    constructor(items: Loaded<Entity, Hint, Fields, Excludes>[], totalCount: IncludeCount extends true ? number : undefined, options: FindByCursorOptions<Entity, Hint, Fields, Excludes, IncludeCount>, meta: EntityMetadata<Entity>);
     get startCursor(): string | null;
     get endCursor(): string | null;
     /**