@opra/mongodb 1.26.3 → 1.27.0

package/services/mongo-collection-service.d.ts

@@ -1,50 +1,47 @@
 import { ExecutionContext, ServiceBase } from '@opra/core';
 import mongodb, { type UpdateFilter } from 'mongodb';
-import type { Nullish, PartialDTO, RequiredSome, Type } from 'ts-gems';
+import type { DTO, Nullish, PartialDTO, RequiredSome, Type } from 'ts-gems';
 import { MongoAdapter } from '../adapter/mongo-adapter.js';
 import type { MongoPatchDTO } from '../types.js';
 import { MongoEntityService } from './mongo-entity-service.js';
 /**
- *
- * @namespace MongoCollectionService
+ * Options for MongoCollectionService.
  */
 export declare namespace MongoCollectionService {
     /**
-     * The constructor options of MongoCollectionService.
-     *
-     * @interface Options
-     * @extends MongoService.Options
+     * Configuration options for MongoCollectionService.
      */
     interface Options extends MongoEntityService.Options {
+        /**
+         * Default maximum number of records returned by `findMany`.
+         */
         defaultLimit?: number;
     }
 }
 /**
- * @class MongoCollectionService
- * @template T - The type of the documents in the collection.
+ * Service for managing a collection of entities backed by a MongoDB data source.
+ *
+ * @template T - The entity type managed by this service.
  */
 export declare class MongoCollectionService<T extends mongodb.Document> extends MongoEntityService<T> {
     /**
-     * Represents the default limit value for a certain operation.
-     *
-     * @type {number}
+     * Default maximum number of records returned by `findMany`.
      */
     defaultLimit: number;
     /**
-     * Constructs a new instance
+     * Constructs a new instance.
      *
-     * @param {Type | string} dataType - The data type of the array elements.
-     * @param {MongoCollectionService.Options} [options] - The options for the array service.
-     * @constructor
+     * @param dataType - The entity class or its registered name.
+     * @param options - Options for the collection service.
      */
     constructor(dataType: Type | string, options?: MongoCollectionService.Options);
     /**
      * Create a copy of this instance with given properties and context applied.
      *
-     * @param {C | ServiceBase} context - The execution context or service base to associate with this instance.
-     * @param {Nullish<P>} [overwriteProperties] - An optional object containing properties to overwrite in the current instance.
-     * @param {Partial<C>} [overwriteContext] - An optional partial context to apply and potentially overwrite parts of the provided execution context.
-     * @return {this & Required<P>} The current instance with the specified properties and context applied.
+     * @param context - The execution context or service base to associate with this instance.
+     * @param [overwriteProperties] - An optional object containing properties to overwrite in the current instance.
+     * @param [overwriteContext] - An optional partial context to apply and potentially overwrite parts of the provided execution context.
+     * @returns The current instance with the specified properties and context applied.
      * @template P
      * @template C
      */
@@ -53,156 +50,208 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * Asserts the existence of a resource with the given ID.
      * Throws a ResourceNotFoundError if the resource does not exist.
      *
-     * @param {MongoAdapter.AnyId} id - The ID of the resource to assert.
-     * @param {MongoEntityService.ExistsOptions<T>} [options] - Optional options for checking the existence.
-     * @returns {Promise<void>} - A Promise that resolves when the resource exists.
-     * @throws {ResourceNotAvailableError} - If the resource does not exist.
+     * @param id - The ID of the resource to assert.
+     * @param options - Optional options for checking the existence.
+     * @returns A Promise that resolves when the resource exists.
+     * @throws {@link ResourceNotAvailableError} - If the resource does not exist.
      */
     assert(id: MongoAdapter.AnyId, options?: MongoEntityService.ExistsOptions<T>): Promise<void>;
     /**
      * Creates a new document in the MongoDB collection.
-     * Interceptors will be called before performing db operation
+     * Interceptors will be called before performing db operation.
      *
-     * @param {PartialDTO<T>} input - The input data for creating the document.
-     * @param {MongoEntityService.CreateOptions} [options] - The options for creating the document.
-     * @returns {Promise<PartialDTO<T>>} A promise that resolves to the created document.
-     * @throws {Error} if an unknown error occurs while creating the document.
+     * @param input - The input data for creating the document.
+     * @param options - The options for creating the document.
+     * @returns A promise that resolves to the created document.
+     * @throws {@link Error} if an unknown error occurs while creating the document.
      */
     create(input: PartialDTO<T> | T, options: RequiredSome<MongoEntityService.CreateOptions, 'projection'>): Promise<PartialDTO<T>>;
     create(input: PartialDTO<T> | T, options?: MongoEntityService.CreateOptions): Promise<T>;
     /**
      * Returns the count of documents in the collection based on the provided options.
      *
-     * @param {MongoEntityService.CountOptions<T>} options - The options for the count operation.
-     * @return {Promise<number>} - A promise that resolves to the count of documents in the collection.
+     * @param options - The options for the count operation.
+     * @returns A promise that resolves to the count of documents in the collection.
      */
     count(options?: MongoEntityService.CountOptions<T>): Promise<number>;
     /**
      * Deletes a document from the collection.
      *
-     * @param {MongoAdapter.AnyId} id - The ID of the document to delete.
-     * @param {MongoEntityService.DeleteOptions<T>} [options] - Optional delete options.
-     * @return {Promise<number>} - A Promise that resolves to the number of documents deleted.
+     * @param id - The ID of the document to delete.
+     * @param [options] - Optional delete options.
+     * @returns A Promise that resolves to the number of documents deleted.
      */
     delete(id: MongoAdapter.AnyId, options?: MongoEntityService.DeleteOptions<T>): Promise<number>;
     /**
      * Deletes multiple documents from the collection that meet the specified filter criteria.
      *
-     * @param {MongoEntityService.DeleteManyOptions<T>} options - The options for the delete operation.
-     * @return {Promise<number>} - A promise that resolves to the number of documents deleted.
+     * @param options - The options for the delete operation.
+     * @returns A promise that resolves to the number of documents deleted.
      */
     deleteMany(options?: MongoEntityService.DeleteManyOptions<T>): Promise<number>;
     /**
      * The distinct command returns a list of distinct values for the given key across a collection.
-     * @param {string} field
-     * @param {MongoEntityService.DistinctOptions<T>} [options]
+     * @param field - The field to get distinct values for.
+     * @param [options] - The options for the distinct operation.
      * @protected
      */
     distinct(field: string, options?: MongoEntityService.DistinctOptions<T>): Promise<any[]>;
     /**
      * Checks if an object with the given id exists.
      *
-     * @param {MongoAdapter.AnyId} id - The id of the object to check.
-     * @param {MongoEntityService.ExistsOptions<T>} [options] - The options for the query (optional).
-     * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the object exists or not.
+     * @param id - The id of the object to check.
+     * @param [options] - The options for the query (optional).
+     * @returns A Promise that resolves to a boolean indicating whether the object exists or not.
      */
     exists(id: MongoAdapter.AnyId, options?: MongoEntityService.ExistsOptions<T>): Promise<boolean>;
     /**
      * Checks if an object with the given arguments exists.
      *
-     * @param {MongoEntityService.ExistsOptions} [options] - The options for the query (optional).
-     * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the object exists or not.
+     * @param [options] - The options for the query (optional).
+     * @returns A Promise that resolves to a boolean indicating whether the object exists or not.
      */
     existsOne(options?: MongoEntityService.ExistsOptions<T>): Promise<boolean>;
     /**
-     * Finds a document by its ID.
+     * Finds a document by its ID and returns it with the requested projection.
      *
-     * @param {MongoAdapter.AnyId} id - The ID of the document.
-     * @param {MongoEntityService.FindOneOptions<T>} [options] - The options for the find query.
-     * @return {Promise<PartialDTO<T | undefined>>} - A promise resolving to the found document, or undefined if not found.
+     * @param id - The ID of the document to find.
+     * @param options - Options including a required `projection`.
+     * @returns A promise that resolves to the found document as a partial DTO, or `undefined` if not found.
      */
     findById(id: MongoAdapter.AnyId, options: RequiredSome<MongoEntityService.FindOneOptions<T>, 'projection'>): Promise<PartialDTO<T> | undefined>;
+    /**
+     * Finds a document by its ID and returns the whole DTO.
+     *
+     * @param id - The ID of the document to find.
+     * @param options - Optional query options.
+     * @returns A promise that resolves to the found document as a full DTO, or `undefined` if not found.
+     */
     findById(id: MongoAdapter.AnyId, options?: MongoEntityService.FindOneOptions<T>): Promise<T | undefined>;
     /**
      * Finds a document in the collection that matches the specified options.
      *
-     * @param {MongoEntityService.FindOneOptions<T>} [options] - The options for the query.
-     * @return {Promise<PartialDTO<T> | undefined>} A promise that resolves with the found document or undefined if no document is found.
+     * @param [options] - The options for the query.
+     * @returns A promise that resolves with the found document or undefined if no document is found.
+     */
+    /**
+     * Finds the first record matching the given options and returns it with the requested projection.
+     *
+     * @param options - Options including a required `projection`.
+     * @returns A promise that resolves to the found record as a partial DTO, or `undefined` if not found.
      */
     findOne(options: RequiredSome<MongoEntityService.FindOneOptions<T>, 'projection'>): Promise<PartialDTO<T> | undefined>;
+    /**
+     * Finds the first record matching the given options and returns the whole DTO.
+     *
+     * @param options - Optional query options.
+     * @returns A promise that resolves to the found record, or `undefined` if not found.
+     */
     findOne(options?: MongoEntityService.FindOneOptions<T>): Promise<T | undefined>;
     /**
-     * Finds multiple documents in the MongoDB collection.
+     * Finds multiple documents matching the given options and returns them with the requested projection.
      *
-     * @param {MongoEntityService.FindManyOptions<T>} options - The options for the find operation.
-     * @return A Promise that resolves to an array of partial outputs of type T.
+     * @param options - Options including a required `projection`.
+     * @returns A promise that resolves to an array of matching documents as partial DTOs.
      */
     findMany(options: RequiredSome<MongoEntityService.FindManyOptions<T>, 'projection'>): Promise<PartialDTO<T>[]>;
-    findMany(options?: MongoEntityService.FindManyOptions<T>): Promise<T[]>;
     /**
-     * Finds multiple documents in the collection and returns both records (max limit)
-     * and total count that matched the given criteria
+     * Finds multiple documents matching the given options and returns them as whole DTOs.
+     *
+     * @param options - Optional query options.
+     * @returns A promise that resolves to an array of matching documents as whole DTOs.
+     */
+    findMany(options?: MongoEntityService.FindManyOptions<T>): Promise<DTO<T>[]>;
+    /**
+     * Finds multiple documents matching the given options and returns them with the total count.
      *
-     * @param {MongoEntityService.FindManyOptions<T>} [options] - The options for the find operation.
-     * @return A Promise that resolves to an array of partial outputs of type T.
+     * @param options - Options including a required `projection`.
+     * @returns An object containing the items (as partial DTOs) and the total count.
      */
     findManyWithCount(options: RequiredSome<MongoEntityService.FindManyOptions<T>, 'projection'>): Promise<{
         count: number;
         items: PartialDTO<T>[];
     }>;
+    /**
+     * Finds multiple documents matching the given options and returns them with the total count.
+     *
+     * @param options - Optional query options.
+     * @returns An object containing the items (as full DTOs) and the total count.
+     */
     findManyWithCount(options?: MongoEntityService.FindManyOptions<T>): Promise<{
         count: number;
-        items: T[];
+        items: DTO<T>[];
     }>;
     /**
-     * Retrieves a document from the collection by its ID. Throws error if not found.
+     * Retrieves a document by its ID and returns it with the requested projection.
+     * Throws a ResourceNotAvailableError if the document does not exist.
      *
-     * @param {MongoAdapter.AnyId} id - The ID of the document to retrieve.
-     * @param {MongoEntityService.FindOneOptions<T>} [options] - Optional options for the findOne operation.
-     * @returns {Promise<PartialDTO<T>>} - A promise that resolves to the retrieved document,
-     *    or rejects with a ResourceNotFoundError if the document does not exist.
-     * @throws {ResourceNotAvailableError} - If the document with the specified ID does not exist.
+     * @param id - The ID of the document to retrieve.
+     * @param options - Options including a required `projection`.
+     * @returns A promise that resolves to the retrieved document as a partial DTO.
+     * @throws {@link ResourceNotAvailableError} If the document does not exist.
      */
     get(id: MongoAdapter.AnyId, options: RequiredSome<MongoEntityService.FindOneOptions<T>, 'projection'>): Promise<PartialDTO<T>>;
+    /**
+     * Retrieves a document by its ID and returns the whole DTO.
+     * Throws a ResourceNotAvailableError if the document does not exist.
+     *
+     * @param id - The ID of the document to retrieve.
+     * @param options - Optional query options.
+     * @returns A promise that resolves to the retrieved document as a full DTO.
+     * @throws {@link ResourceNotAvailableError} If the document does not exist.
+     */
     get(id: MongoAdapter.AnyId, options?: MongoEntityService.FindOneOptions<T>): Promise<T>;
     /**
-     * Replace a document in the MongoDB collection.
-     * Interceptors will be called before performing db operation
+     * Replaces a document by its ID and returns it with the requested projection.
      *
-     * @param {MongoAdapter.AnyId} id - The id of the document to replace.
-     * @param {PartialDTO<T>} input - The input data
-     * @param {MongoEntityService.ReplaceOptions} [options] - The options for replacing the document.
-     * @returns {Promise<PartialDTO<T>>} A promise that resolves to the replaced document.
-     * @throws {Error} if an unknown error occurs while replacing the document.
+     * @param id - The ID of the document to replace.
+     * @param input - The replacement document data.
+     * @param options - Options including a required `projection`.
+     * @returns A promise that resolves to the replaced document as a partial DTO, or `undefined` if not found.
      */
     replace(id: MongoAdapter.AnyId, input: PartialDTO<T>, options: RequiredSome<MongoEntityService.ReplaceOptions<T>, 'projection'>): Promise<PartialDTO<T>>;
+    /**
+     * Replaces a document by its ID and returns the whole replaced DTO.
+     *
+     * @param id - The ID of the document to replace.
+     * @param input - The replacement document data.
+     * @param options - Optional replace options.
+     * @returns A promise that resolves to the replaced document as a full DTO, or `undefined` if not found.
+     */
     replace(id: MongoAdapter.AnyId, input: PartialDTO<T>, options?: MongoEntityService.CreateOptions): Promise<T>;
     /**
-     * Updates a document with the given id in the collection.
+     * Updates a document by its ID and returns it with the requested projection.
      *
-     * @param {MongoAdapter.AnyId} id - The id of the document to update.
-     * @param {MongoPatchDTO<T>|UpdateFilter<T>} input - The partial input object containing the fields to update.
-     * @param {MongoEntityService.UpdateOneOptions<T>} [options] - The options for the update operation.
-     * @returns {Promise<PartialDTO<T> | undefined>} A promise that resolves to the updated document or
-     * undefined if the document was not found.
+     * @param id - The ID of the document to update.
+     * @param input - The fields to update.
+     * @param options - Options including a required `projection`.
+     * @returns A promise that resolves to the updated document as a partial DTO, or `undefined` if not found.
      */
     update(id: MongoAdapter.AnyId, input: MongoPatchDTO<T> | UpdateFilter<T>, options: RequiredSome<MongoEntityService.UpdateOneOptions<T>, 'projection'>): Promise<PartialDTO<T> | undefined>;
+    /**
+     * Updates a document by its ID and returns the whole updated DTO.
+     *
+     * @param id - The ID of the document to update.
+     * @param input - The fields to update.
+     * @param options - Optional update options.
+     * @returns A promise that resolves to the updated document as a full DTO, or `undefined` if not found.
+     */
     update(id: MongoAdapter.AnyId, input: MongoPatchDTO<T> | UpdateFilter<T>, options?: MongoEntityService.UpdateOneOptions<T>): Promise<T | undefined>;
     /**
      * Updates a document in the collection with the specified ID.
      *
-     * @param {MongoAdapter.AnyId} id - The ID of the document to update.
-     * @param {MongoPatchDTO<T>|UpdateFilter<T>} input - The partial input data to update the document with.
-     * @param {MongoEntityService.UpdateOneOptions<T>} [options] - The options for updating the document.
-     * @returns {Promise<number>} - A promise that resolves to the number of documents modified.
+     * @param id - The ID of the document to update.
+     * @param input - The partial input data to update the document with.
+     * @param [options] - The options for updating the document.
+     * @returns A promise that resolves to the number of documents modified.
      */
     updateOnly(id: MongoAdapter.AnyId, input: MongoPatchDTO<T> | UpdateFilter<T>, options?: MongoEntityService.UpdateOneOptions<T>): Promise<number>;
     /**
      * Updates multiple documents in the collection based on the specified input and options.
      *
-     * @param {MongoPatchDTO<T>|UpdateFilter<T>} input - The partial input to update the documents with.
-     * @param {MongoEntityService.UpdateManyOptions<T>} options - The options for updating the documents.
-     * @return {Promise<number>} - A promise that resolves to the number of documents matched and modified.
+     * @param input - The partial input to update the documents with.
+     * @param [options] - The options for updating the documents.
+     * @returns A promise that resolves to the number of documents matched and modified.
      */
     updateMany(input: MongoPatchDTO<T> | UpdateFilter<T>, options?: MongoEntityService.UpdateManyOptions<T>): Promise<number>;
 }

package/services/mongo-collection-service.js

@@ -2,22 +2,20 @@ import { ResourceNotAvailableError } from '@opra/common';
 import { MongoAdapter } from '../adapter/mongo-adapter.js';
 import { MongoEntityService } from './mongo-entity-service.js';
 /**
- * @class MongoCollectionService
- * @template T - The type of the documents in the collection.
+ * Service for managing a collection of entities backed by a MongoDB data source.
+ *
+ * @template T - The entity type managed by this service.
  */
 export class MongoCollectionService extends MongoEntityService {
     /**
-     * Represents the default limit value for a certain operation.
-     *
-     * @type {number}
+     * Default maximum number of records returned by `findMany`.
      */
     defaultLimit;
     /**
-     * Constructs a new instance
+     * Constructs a new instance.
      *
-     * @param {Type | string} dataType - The data type of the array elements.
-     * @param {MongoCollectionService.Options} [options] - The options for the array service.
-     * @constructor
+     * @param dataType - The entity class or its registered name.
+     * @param options - Options for the collection service.
      */
     constructor(dataType, options) {
         super(dataType, options);
@@ -26,10 +24,10 @@ export class MongoCollectionService extends MongoEntityService {
     /**
      * Create a copy of this instance with given properties and context applied.
      *
-     * @param {C | ServiceBase} context - The execution context or service base to associate with this instance.
-     * @param {Nullish<P>} [overwriteProperties] - An optional object containing properties to overwrite in the current instance.
-     * @param {Partial<C>} [overwriteContext] - An optional partial context to apply and potentially overwrite parts of the provided execution context.
-     * @return {this & Required<P>} The current instance with the specified properties and context applied.
+     * @param context - The execution context or service base to associate with this instance.
+     * @param [overwriteProperties] - An optional object containing properties to overwrite in the current instance.
+     * @param [overwriteContext] - An optional partial context to apply and potentially overwrite parts of the provided execution context.
+     * @returns The current instance with the specified properties and context applied.
      * @template P
      * @template C
      */
@@ -40,10 +38,10 @@ export class MongoCollectionService extends MongoEntityService {
      * Asserts the existence of a resource with the given ID.
      * Throws a ResourceNotFoundError if the resource does not exist.
      *
-     * @param {MongoAdapter.AnyId} id - The ID of the resource to assert.
-     * @param {MongoEntityService.ExistsOptions<T>} [options] - Optional options for checking the existence.
-     * @returns {Promise<void>} - A Promise that resolves when the resource exists.
-     * @throws {ResourceNotAvailableError} - If the resource does not exist.
+     * @param id - The ID of the resource to assert.
+     * @param options - Optional options for checking the existence.
+     * @returns A Promise that resolves when the resource exists.
+     * @throws {@link ResourceNotAvailableError} - If the resource does not exist.
      */
     async assert(id, options) {
         if (!(await this.exists(id, options)))
@@ -78,8 +76,8 @@ export class MongoCollectionService extends MongoEntityService {
     /**
      * Returns the count of documents in the collection based on the provided options.
      *
-     * @param {MongoEntityService.CountOptions<T>} options - The options for the count operation.
-     * @return {Promise<number>} - A promise that resolves to the count of documents in the collection.
+     * @param options - The options for the count operation.
+     * @returns A promise that resolves to the count of documents in the collection.
      */
     async count(options) {
         const command = {
@@ -103,9 +101,9 @@ export class MongoCollectionService extends MongoEntityService {
     /**
      * Deletes a document from the collection.
      *
-     * @param {MongoAdapter.AnyId} id - The ID of the document to delete.
-     * @param {MongoEntityService.DeleteOptions<T>} [options] - Optional delete options.
-     * @return {Promise<number>} - A Promise that resolves to the number of documents deleted.
+     * @param id - The ID of the document to delete.
+     * @param [options] - Optional delete options.
+     * @returns A Promise that resolves to the number of documents deleted.
      */
     async delete(id, options) {
         const command = {
@@ -130,8 +128,8 @@ export class MongoCollectionService extends MongoEntityService {
     /**
      * Deletes multiple documents from the collection that meet the specified filter criteria.
      *
-     * @param {MongoEntityService.DeleteManyOptions<T>} options - The options for the delete operation.
-     * @return {Promise<number>} - A promise that resolves to the number of documents deleted.
+     * @param options - The options for the delete operation.
+     * @returns A promise that resolves to the number of documents deleted.
      */
     async deleteMany(options) {
         const command = {
@@ -154,8 +152,8 @@ export class MongoCollectionService extends MongoEntityService {
     }
     /**
      * The distinct command returns a list of distinct values for the given key across a collection.
-     * @param {string} field
-     * @param {MongoEntityService.DistinctOptions<T>} [options]
+     * @param field - The field to get distinct values for.
+     * @param [options] - The options for the distinct operation.
      * @protected
      */
     async distinct(field, options) {
@@ -181,9 +179,9 @@ export class MongoCollectionService extends MongoEntityService {
     /**
      * Checks if an object with the given id exists.
      *
-     * @param {MongoAdapter.AnyId} id - The id of the object to check.
-     * @param {MongoEntityService.ExistsOptions<T>} [options] - The options for the query (optional).
-     * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the object exists or not.
+     * @param id - The id of the object to check.
+     * @param [options] - The options for the query (optional).
+     * @returns A Promise that resolves to a boolean indicating whether the object exists or not.
      */
     async exists(id, options) {
         const command = {
@@ -213,8 +211,8 @@ export class MongoCollectionService extends MongoEntityService {
     /**
      * Checks if an object with the given arguments exists.
      *
-     * @param {MongoEntityService.ExistsOptions} [options] - The options for the query (optional).
-     * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the object exists or not.
+     * @param [options] - The options for the query (optional).
+     * @returns A Promise that resolves to a boolean indicating whether the object exists or not.
      */
     async existsOne(options) {
         return !!(await this.findOne({ ...options, projection: ['_id'] }));
@@ -356,10 +354,10 @@ export class MongoCollectionService extends MongoEntityService {
     /**
      * Updates a document in the collection with the specified ID.
      *
-     * @param {MongoAdapter.AnyId} id - The ID of the document to update.
-     * @param {MongoPatchDTO<T>|UpdateFilter<T>} input - The partial input data to update the document with.
-     * @param {MongoEntityService.UpdateOneOptions<T>} [options] - The options for updating the document.
-     * @returns {Promise<number>} - A promise that resolves to the number of documents modified.
+     * @param id - The ID of the document to update.
+     * @param input - The partial input data to update the document with.
+     * @param [options] - The options for updating the document.
+     * @returns A promise that resolves to the number of documents modified.
      */
     async updateOnly(id, input, options) {
         const isUpdateFilter = Array.isArray(input) || !!Object.keys(input).find(x => x.startsWith('$'));
@@ -387,9 +385,9 @@ export class MongoCollectionService extends MongoEntityService {
     /**
      * Updates multiple documents in the collection based on the specified input and options.
      *
-     * @param {MongoPatchDTO<T>|UpdateFilter<T>} input - The partial input to update the documents with.
-     * @param {MongoEntityService.UpdateManyOptions<T>} options - The options for updating the documents.
-     * @return {Promise<number>} - A promise that resolves to the number of documents matched and modified.
+     * @param input - The partial input to update the documents with.
+     * @param [options] - The options for updating the documents.
+     * @returns A promise that resolves to the number of documents matched and modified.
      */
     async updateMany(input, options) {
         const isUpdateFilter = Array.isArray(input) || !!Object.keys(input).find(x => x.startsWith('$'));