@opra/mongodb 0.33.2 → 0.33.4

package/types/mongo-service.d.ts

@@ -15,76 +15,63 @@ export declare class MongoService<T extends mongodb.Document> extends ApiService
     protected _dataType: Type | string;
     /**
      * Represents the name of a collection in MongoDB
-     *
-     * @type {string | Function} collectionName
      */
     collectionName?: string | ((_this: any) => string);
     /**
      * Represents the name of a resource.
-     *
      * @type {string}
      */
     resourceName?: string | ((_this: any) => string);
     /**
      * Represents a MongoDB database object.
-     * @type {mongodb.Db | Function}
      */
     db?: mongodb.Db | ((_this: any) => mongodb.Db);
     /**
      * Represents a MongoDB ClientSession.
-     *
-     * @type {mongodb.ClientSession}
      */
     session?: mongodb.ClientSession | ((_this: any) => mongodb.ClientSession);
     /**
      * Generates a new id for new inserting Document.
      *
      * @protected
-     * @returns {AnyId} A new instance of AnyId.
      */
     $idGenerator?: (_this: any) => AnyId;
     /**
      * Callback function for handling errors.
      *
      * @param {unknown} error - The error object.
-     * @param {object} _this - The context object.
-     * @return {void|Promise<void>} - A void value or a promise that resolves to void.
+     * @param _this - The context object.
      */
     $onError?: (error: unknown, _this: any) => void | Promise<void>;
     /**
      * Constructs a new instance
      *
-     * @param {Type | string} dataType - The data type of the array elements.
-     * @param {MongoService.Options} [options] - The options for the array service.
+     * @param dataType - The data type of the array elements.
+     * @param [options] - The options for the array service.
      * @constructor
      */
     constructor(dataType: Type | string, options?: MongoService.Options);
     /**
      * Retrieves the data type of the document
      *
-     * @returns {ComplexType} The complex data type of the field.
      * @throws {NotAcceptableError} If the data type is not a ComplexType.
      */
     getDataType(): ComplexType;
     /**
      * Retrieves the encoder for the specified operation.
      *
-     * @param {String} operation - The operation to retrieve the encoder for. Valid values are 'create' and 'update'.
-     * @returns {IsObject.Validator<T>} - The encoder for the specified operation.
+     * @param operation - The operation to retrieve the encoder for. Valid values are 'create' and 'update'.
      */
     getEncoder(operation: 'create' | 'update'): IsObject.Validator<T>;
     /**
      * Retrieves the decoder.
-     *
-     * @returns {IsObject.Validator<T>} - The encoder for the specified operation.
      */
     getDecoder(): IsObject.Validator<T>;
     /**
      * Executes the provided function within a transaction.
      *
-     * @param {WithTransactionCallback} callback - The function to be executed within the transaction.
-     * @param {TransactionOptions} [options] - Optional options for the transaction.
-     * @returns {Promise<any>} - A promise that resolves with the result of the function execution within the transaction.
+     * @param callback - The function to be executed within the transaction.
+     * @param [options] - Optional options for the transaction.
      */
     withTransaction(callback: WithTransactionCallback, options?: TransactionOptions): Promise<any>;
     /**
@@ -92,103 +79,101 @@ export declare class MongoService<T extends mongodb.Document> extends ApiService
      * one will be added to each of the documents missing it by the driver, mutating the document. This behavior
      * can be overridden by setting the **forceServerObjectId** flag.
      *
-     * @param {T} doc - The document to be inserted.
-     * @param {mongodb.InsertOneOptions} options - The options for the insert operation.
-     * @returns {Promise<mongodb.InsertOneWriteOpResult<mongodb.OptionalId<T>>>} - A promise that resolves with the result of the insert operation.
+     * @param doc - The document to insert
+     * @param options - Optional settings for the command
      * @protected
      */
     protected __insertOne(doc: mongodb.OptionalUnlessRequiredId<T>, options?: mongodb.InsertOneOptions): Promise<mongodb.InsertOneResult<T>>;
     /**
      * Gets the number of documents matching the filter.
      *
-     * @param {mongodb.Filter<T>} filter - The filter used to match documents.
-     * @param {mongodb.CountOptions} options - The options for counting documents.
-     * @returns {Promise<number>} - The number of documents matching the filter.
+     * @param filter - The filter used to match documents.
+     * @param options - The options for counting documents.
      * @protected
      */
     protected __countDocuments(filter?: mongodb.Filter<T>, options?: mongodb.CountOptions): Promise<number>;
     /**
      * Delete a document from a collection
      *
-     * @param {mongodb.Filter<T>} filter - The filter used to select the document to remove
-     * @param {mongodb.DeleteOptions} options - Optional settings for the command
-     * @return {Promise<mongodb.DeleteResult>} A Promise that resolves to the result of the delete operation
+     * @param filter - The filter used to select the document to remove
+     * @param options - Optional settings for the command
+     * @protected
      */
     protected __deleteOne(filter?: mongodb.Filter<T>, options?: mongodb.DeleteOptions): Promise<mongodb.DeleteResult>;
     /**
-     * Deletes multiple documents from a collection.
+     * Delete multiple documents from a collection
      *
-     * @param {mongodb.Filter<T>} [filter] - The filter object specifying the documents to delete.
-     * If not provided, all documents in the collection will be deleted.
-     * @param {mongodb.DeleteOptions} [options] - The options for the delete operation.
-     * @returns {Promise<mongodb.DeleteResult>} A promise that resolves with the delete result object.
+     * @param filter - The filter used to select the documents to remove
+     * @param options - Optional settings for the command
      * @protected
      */
     protected __deleteMany(filter?: mongodb.Filter<T>, options?: mongodb.DeleteOptions): Promise<mongodb.DeleteResult>;
     /**
-     * Create a new Change Stream, watching for new changes
-     * (insertions, updates, replacements, deletions, and invalidations) in this collection.
+     * Gets the number of documents matching the filter.
+     *
+     * @param field - Field of the document to find distinct values for
+     * @param filter - The filter for filtering the set of documents to which we apply the distinct filter.
+     * @param options - Optional settings for the command
+     * @protected
+     */
+    protected __distinct(field: string, filter?: mongodb.Filter<T>, options?: mongodb.DistinctOptions): Promise<any[]>;
+    /**
+     * Execute an aggregation framework pipeline against the collection, needs MongoDB \>= 2.2
      *
-     * @param {mongodb.Document[]} pipeline - The pipeline of aggregation stages to apply to the collection.
-     * @param {mongodb.AggregateOptions} options - The options to customize the aggregation.
-     * @returns {Promise<mongodb.ChangeStream<T>>} - A promise that resolves to a Change Stream that represents the result of the aggregation.
+     * @param pipeline - An array of aggregation pipelines to execute
+     * @param options - Optional settings for the command
      * @protected
      */
     protected __aggregate(pipeline?: mongodb.Document[], options?: mongodb.AggregateOptions): Promise<mongodb.AggregationCursor<T>>;
     /**
      * Fetches the first document that matches the filter
      *
-     * @param {mongodb.Filter<T>} filter - The filter object to match documents against
-     * @param {mongodb.FindOptions} [options] - The options to use when querying the collection
+     * @param filter - Query for find Operation
+     * @param options - Optional settings for the command
      * @protected
-     * @returns {Promise<PartialDTO<T> | undefined>} - A promise that resolves to the first matching document, or undefined if no match is found
      */
     protected __findOne(filter: mongodb.Filter<T>, options?: mongodb.FindOptions): Promise<PartialDTO<T> | undefined>;
     /**
-     * Creates a cursor for a filter that can be used to iterate over results from MongoDB.
+     * Creates a cursor for a filter that can be used to iterate over results from MongoDB
      *
-     * @param {mongodb.Filter<T>} filter - The filter to apply when searching for results.
-     * @param {mongodb.FindOptions} [options] - The options to customize the search behavior.
-     * @returns {mongodb.Cursor<T>} - The cursor object that can be used to iterate over the results.
+     * @param filter - The filter predicate. If unspecified,
+     * then all documents in the collection will match the predicate
+     * @param options - Optional settings for the command
      * @protected
      */
     protected __find(filter: mongodb.Filter<T>, options?: mongodb.FindOptions): Promise<mongodb.FindCursor<T>>;
     /**
-     * Update a single document in a collection.
+     * Update a single document in a collection
      *
-     * @param {mongodb.Filter<T>} filter - The filter to select the document(s) to update.
-     * @param {mongodb.UpdateFilter<T>} update - The update operation to be applied on the selected document(s).
-     * @param {mongodb.UpdateOptions} [options] - Optional settings for the update operation.
+     * @param filter - The filter used to select the document to update
+     * @param update - The update operations to be applied to the document
+     * @param options - Optional settings for the command
      * @protected
-     * @returns {Promise<mongodb.UpdateResult>} - A promise that resolves to the result of the update operation.
      */
     protected __updateOne(filter: mongodb.Filter<T>, update: mongodb.UpdateFilter<T>, options?: mongodb.UpdateOptions): Promise<mongodb.UpdateResult<T>>;
     /**
      * Find a document and update it in one atomic operation. Requires a write lock for the duration of the operation.
      *
-     * @param {mongodb.Filter<T>} filter - The filter to select the document to be updated.
-     * @param {mongodb.UpdateFilter<T>} doc - The update document.
-     * @param {mongodb.FindOneAndUpdateOptions} [options] - Optional options for the find one and update operation.
-     * @returns {Promise<T | null>} - A promise that resolves to the updated document or null if no document matched the filter.
+     * @param filter - The filter used to select the document to update
+     * @param update - Update operations to be performed on the document
+     * @param options - Optional settings for the command
      * @protected
      */
-    protected __findOneAndUpdate(filter: mongodb.Filter<T>, doc: mongodb.UpdateFilter<T>, options?: mongodb.FindOneAndUpdateOptions): Promise<mongodb.WithId<T> | null>;
+    protected __findOneAndUpdate(filter: mongodb.Filter<T>, update: mongodb.UpdateFilter<T>, options?: mongodb.FindOneAndUpdateOptions): Promise<mongodb.WithId<T> | null>;
     /**
-     * Update multiple documents in a collection.
+     * Update multiple documents in a collection
      *
-     * @param {mongodb.Filter<T>} filter - The filter used to select the documents to be updated.
-     * @param {mongodb.UpdateFilter<T> | Partial<T>} doc - The updates to be applied to the selected documents.
-     * @param {StrictOmit<mongodb.UpdateOptions, 'upsert'>} [options] - The optional settings for the update operation.
-     * @return {Promise<mongodb.UpdateResult>} - A Promise that resolves to the result of the update operation.
+     * @param filter - The filter used to select the documents to update
+     * @param update - The update operations to be applied to the documents
+     * @param options - Optional settings for the command
      * @protected
      */
-    protected __updateMany(filter: mongodb.Filter<T>, doc: mongodb.UpdateFilter<T> | Partial<T>, options?: StrictOmit<mongodb.UpdateOptions, 'upsert'>): Promise<mongodb.UpdateResult<T>>;
+    protected __updateMany(filter: mongodb.Filter<T>, update: mongodb.UpdateFilter<T> | Partial<T>, options?: StrictOmit<mongodb.UpdateOptions, 'upsert'>): Promise<mongodb.UpdateResult<T>>;
     /**
      * Retrieves the database connection.
      *
      * @protected
      *
-     * @returns {Promise<mongodb.Db>} The database connection.
      * @throws {Error} If the context or database is not set.
      */
     protected getDatabase(): mongodb.Db;
@@ -197,23 +182,21 @@ export declare class MongoService<T extends mongodb.Document> extends ApiService
      *
      * @protected
      *
-     * @returns {Promise<mongodb.ClientSession>} The database connection.
      * @throws {Error} If the context or database is not set.
      */
     protected getSession(): mongodb.ClientSession | undefined;
     /**
      * Retrieves a MongoDB collection from the given database.
      *
-     * @param {mongodb.Db} db - The MongoDB database.
+     * @param db - The MongoDB database.
      * @protected
-     * @returns {Promise<mongodb.Collection<T>>} A promise that resolves to the MongoDB collection.
      */
     protected getCollection(db: mongodb.Db): Promise<mongodb.Collection<T>>;
     /**
      * Retrieves the collection name.
      *
      * @protected
-     * @returns {string} The collection name.
+     * @returns The collection name.
      * @throws {Error} If the collection name is not defined.
      */
     getCollectionName(): string;
@@ -221,23 +204,23 @@ export declare class MongoService<T extends mongodb.Document> extends ApiService
      * Retrieves the resource name.
      *
      * @protected
-     * @returns {string} The collection name.
+     * @returns {string} The resource name.
      * @throws {Error} If the collection name is not defined.
      */
     getResourceName(): string;
     /**
      * Generates an encoder for the specified operation.
      *
-     * @param {string} operation - The operation to generate the encoder for. Must be either 'create' or 'update'.
+     * @param operation - The operation to generate the encoder for. Must be either 'create' or 'update'.
      * @protected
-     * @returns {IsObject.Validator} - The generated encoder for the specified operation.
+     * @returns - The generated encoder for the specified operation.
      */
     protected _generateEncoder(operation: 'create' | 'update'): IsObject.Validator<T>;
     /**
      * Generates an encoder for the specified operation.
      *
      * @protected
-     * @returns {IsObject.Validator} - The generated encoder for the specified operation.
+     * @returns - The generated encoder for the specified operation.
      */
     protected _generateDecoder(): IsObject.Validator<T>;
 }