@futdevpro/nts-dynamo 1.5.51 → 1.5.52

package/lib/_services/dynamo-nts-db.service.d.ts

@@ -59,18 +59,6 @@ export declare class DynamoNTS_DBService<T extends Dynamo_Metadata> {
      * @returns dataList
      */
     searchData(searchBy: object, narrowByDependencyIds?: string[]): Promise<T[]>;
-    /**
-     * find data by any of its parameters, throws error if not found
-     * @param data
-     * (always use unique parameters for find!)
-     * etc.: by email:
-     * @example { email: email }
-     * or by id that is in list:
-     * @example { userIds: { $in: this.userId } }
-     * or by number or Date that is greater than OR less than:
-     * @example { points: { $gte: 2, $lte: 14 } }
-     * @returns data
-     */
     /**
      * returns all data from database, throws error if not found
      * @returns dataList
@@ -87,64 +75,85 @@ export declare class DynamoNTS_DBService<T extends Dynamo_Metadata> {
      */
     deleteDataByDependencyId(dependencyId: string): Promise<void>;
     /**
-     * find the data first by any of its parameters, throws error if not found
-     * @param filter
-     * (always use unique parameters for find!)
-     * etc.: by email:
-     * @example { email: email }
-     * or by id that is in list:
-     * @example { userIds: { $in: this.userId } }
-     * or by number or Date that is GREATER THAN OR LESS THAN:
-     * @example { points: { $gt: 2, $lt: 14 } }
-     * further tools (syntax matches with $gt):
-     * $eq: Matches values that are EQUAL to a specified value.
-     * $gte: Matches values that are GREATER THAN or EQUAL to a specified value.
-     * $lte: Matches values that are LESS THAN or EQUAL to a specified value.
-     * $ne: Matches all values that are NOT EQUAL to a specified value.
-     * $nin: Matches NONE of the values specified IN an array.
+     * Find the data first by any of its parameters, throws error if not found
+     * @param filter if you can, use unique parameters for find!
      *
-     * @returns data
+     * @example
+     * // by email:
+     * { email: email }
+     * //
+     * @example
+     * // or by id that is in list:
+     * { userIds: { $in: this.userId } }
+     * //
+     * @example
+     * // or by number or Date that is Greater Than AND Less Than:
+     * { points: { $gt: 2, $lt: 14 } }
+     * // further tools (syntax matches with $gt):
+     * $eq:  // Matches values that are EQual to a specified value.
+     * $gte: // Matches values that are Greater Than OR Equal to a specified value.
+     * $lte: // Matches values that are Less Than or Equal to a specified value.
+     * $ne:  // Matches all values that are Not Equal to a specified value.
+     * $nin: // Matches None of the values specified IN an array.
+     * //
+     * @returns {T} data: T
      */
     findOne(filter: any): Promise<T>;
     /**
-     * find all data by any of its parameters, throws error if not found
-     * @param filter
-     * etc.: by email:
-     * @example { email: email }
-     * or by id that is in list:
-     * @example { userIds: { $in: this.userId } }
-     * or by number or Date that is GREATER THAN OR LESS THAN:
-     * @example { points: { $gt: 2, $lt: 14 } }
-     * further tools (syntax matches with $gt):
-     * $eq: Matches values that are EQUAL to a specified value.
-     * $gte: Matches values that are GREATER THAN or EQUAL to a specified value.
-     * $lte: Matches values that are LESS THAN or EQUAL to a specified value.
-     * $ne: Matches all values that are NOT EQUAL to a specified value.
-     * $nin: Matches NONE of the values specified IN an array.
+     * Find the data first by any of its parameters, throws error if not found
+     * @param filter if you can, use unique parameters for find!
      *
-     * @returns dataList
+     * @example
+     * // by email:
+     * { email: email }
+     * //
+     * @example
+     * // or by id that is in list:
+     * { userIds: { $in: this.userId } }
+     * //
+     * @example
+     * // or by number or Date that is Greater Than AND Less Than:
+     * { points: { $gt: 2, $lt: 14 } }
+     * // further tools (syntax matches with $gt):
+     * $eq:  // Matches values that are EQual to a specified value.
+     * $gte: // Matches values that are Greater Than OR Equal to a specified value.
+     * $lte: // Matches values that are Less Than or Equal to a specified value.
+     * $ne:  // Matches all values that are Not Equal to a specified value.
+     * $nin: // Matches None of the values specified IN an array.
+     * //
+     * @returns {T[]} dataList: T[]
      */
     find(filter: any): Promise<T[]>;
     /**
-     * find all data by any of its parameters, throws error if not found
-     * @param filter
-     * etc.: by email:
-     * @example { email: email }
-     * or by id that is in list:
-     * @example { userIds: { $in: this.userId } }
-     * or by number or Date that is GREATER THAN OR LESS THAN:
-     * @example { points: { $gt: 2, $lt: 14 } }
-     * further tools (syntax matches with $gt):
-     * $eq: Matches values that are EQUAL to a specified value.
-     * $gte: Matches values that are GREATER THAN or EQUAL to a specified value.
-     * $lte: Matches values that are LESS THAN or EQUAL to a specified value.
-     * $ne: Matches all values that are NOT EQUAL to a specified value.
-     * $nin: Matches NONE of the values specified IN an array.
+     * Find the data first by any of its parameters, throws error if not found
+     * @param filter if you can, use unique parameters for find!
      *
+     * @example
+     * // by email:
+     * { email: email }
+     * //
+     * @example
+     * // or by id that is in list:
+     * { userIds: { $in: this.userId } }
+     * //
+     * @example
+     * // or by number or Date that is Greater Than AND Less Than:
+     * { points: { $gt: 2, $lt: 14 } }
+     * // further tools (syntax matches with $gt):
+     * $eq:  // Matches values that are EQual to a specified value.
+     * $gte: // Matches values that are Greater Than OR Equal to a specified value.
+     * $lte: // Matches values that are Less Than or Equal to a specified value.
+     * $ne:  // Matches all values that are Not Equal to a specified value.
+     * $nin: // Matches None of the values specified IN an array.
+     * //
      * @param page page
      * @param pageSize pageSize
-     * @param sort etc. by dateTime: { dateTime: -1 }
-     * @returns dataList
+     * @param sort
+     * @example
+     * // by dateTime (this uses the basic sort function):
+     * { dateTime: -1 }
+     * //
+     * @returns {T[]} dataList: T[]
      */
     findWithPaging(filter: any, page: number, pageSize: number, sort?: any): Promise<T[]>;
     /**
@@ -155,70 +164,106 @@ export declare class DynamoNTS_DBService<T extends Dynamo_Metadata> {
      */
     findByIdAndUpdate(id: string, update: any, modifier: string): Promise<T>;
     /**
-     * update one parameter by a specific
-     * @param updateBy
-     * (always use unique parameters for find!)
-     * etc.: by email:
-     * @example { email: email }
-     * or by id that is in list:
-     * @example { userIds: { $in: this.userId } }
-     * or by number or Date that is GREATER THAN OR LESS THAN:
-     * @example { points: { $gt: 2, $lt: 14 } }
-     * further tools (syntax matches with $gt):
-     * $eq: Matches values that are EQUAL to a specified value.
-     * $gte: Matches values that are GREATER THAN or EQUAL to a specified value.
-     * $lte: Matches values that are LESS THAN or EQUAL to a specified value.
-     * $ne: Matches all values that are NOT EQUAL to a specified value.
-     * $nin: Matches NONE of the values specified IN an array.
+     * Find the data first by any of its parameters, throws error if not found
+     * @param filter This uses the basic Mongoose updateOne.
+     * If you can, use unique parameters for find!
+     * @example
+     * // by email:
+     * { email: email }
+     * //
+     * @example
+     * // or by id that is in list:
+     * { userIds: { $in: this.userId } }
+     * //
+     * @example
+     * // or by number or Date that is Greater Than AND Less Than:
+     * { points: { $gt: 2, $lt: 14 } }
+     * // further tools (syntax matches with $gt):
+     * $eq:  // Matches values that are EQual to a specified value.
+     * $gte: // Matches values that are Greater Than OR Equal to a specified value.
+     * $lte: // Matches values that are Less Than or Equal to a specified value.
+     * $ne:  // Matches all values that are Not Equal to a specified value.
+     * $nin: // Matches None of the values specified IN an array.
+     * //
      *
-     * @param update
-     * etc.: increase a specific value:
-     * @example { $inc: { popularity: 15 } }
-     * or add element to a list:
-     * @example { $push: { reactions: this.newReaction }
-     * or all at once
-     * @example { $inc: { popularity: this.newVote.amount }, emailVerified: true, $push: { reactions: this.newReaction } }
-     * further tools (syntax matches with $inc):
-     * $currentDate: Sets the value of a field to current date, either as a Date or a Timestamp.
-     * $min: Only updates the field if the specified value is less than the existing field value.
-     * $max: Only updates the field if the specified value is greater than the existing field value.
-     * $mul: Multiplies the value of the field by the specified amount.
-     * $rename: Renames a field.
-     * $unset: Removes the specified field from a document. (set: "" to value)
-     */
-    updateOne(updateBy: any, update: any, modifier: string): Promise<void>;
+     * @param update this uses the basic Mongoose updateOne
+     * @example
+     * // increase a specific value (here by 15):
+     * { $inc: { popularity: 15 } }
+     * //
+     * @example
+     * // or add element to a list:
+     * { $push: { reactions: this.newReaction }
+     * // or add multiple elements to a list
+     * { $push: { schedule: {$each: [ monday, tuesday, wednesday ] } } }
+     * //
+     * @example
+     * // or all at once
+     * {
+     *   $inc: { popularity: this.newVote.amount },
+     *   emailVerified: true,
+     *   $push: { reactions: this.newReaction }
+     * }
+     * // further tools (syntax matches with $inc):
+     * $currentDate: // Sets the value of a field to current date, either as a Date or a Timestamp.
+     * $min:         // Only updates the field if the specified value is less than the existing field value.
+     * $max:         // Only updates the field if the specified value is greater than the existing field value.
+     * $mul:         // Multiplies the value of the field by the specified amount.
+     * $rename:      // Renames a field.
+     * $unset:       // Removes the specified field from a document. (set: "" to value)
+     * //
+     */
+    updateOne(updateBy: any, update: any, modifier: string): Promise<T>;
     /**
      * update one parameter by a specific
-     * @param updateBy
-     * etc.: by email:
-     * @example { email: email }
-     * or by id that is in list:
-     * @example { userIds: { $in: this.userId } }
-     * or by number or Date that is GREATER THAN OR LESS THAN:
-     * @example { points: { $gt: 2, $lt: 14 } }
-     * further tools (syntax matches with $gt):
-     * $eq: Matches values that are EQUAL to a specified value.
-     * $gte: Matches values that are GREATER THAN or EQUAL to a specified value.
-     * $lte: Matches values that are LESS THAN or EQUAL to a specified value.
-     * $ne: Matches all values that are NOT EQUAL to a specified value.
-     * $nin: Matches NONE of the values specified IN an array.
+     * @param filter This uses the basic Mongoose updateMany.
+     * @example
+     * // by email:
+     * { email: email }
+     * //
+     * @example
+     * // or by id that is in list:
+     * { userIds: { $in: this.userId } }
+     * //
+     * @example
+     * // or by number or Date that is Greater Than AND Less Than:
+     * { points: { $gt: 2, $lt: 14 } }
+     * // further tools (syntax matches with $gt):
+     * $eq:  // Matches values that are EQual to a specified value.
+     * $gte: // Matches values that are Greater Than OR Equal to a specified value.
+     * $lte: // Matches values that are Less Than or Equal to a specified value.
+     * $ne:  // Matches all values that are Not Equal to a specified value.
+     * $nin: // Matches None of the values specified IN an array.
+     * //
      *
-     * @param update
-     * etc.: increase a specific value:
-     * @example { $inc: { popularity: 15 } }
-     * or add element to a list:
-     * @example { $push: { reactions: this.newReaction }
-     * or all at once
-     * @example { $inc: { popularity: this.newVote.amount }, emailVerified: true, $push: { reactions: this.newReaction } }
-     * further tools (syntax matches with $inc):
-     * $currentDate: Sets the value of a field to current date, either as a Date or a Timestamp.
-     * $min: Only updates the field if the specified value is less than the existing field value.
-     * $max: Only updates the field if the specified value is greater than the existing field value.
-     * $mul: Multiplies the value of the field by the specified amount.
-     * $rename: Renames a field.
-     * $unset: Removes the specified field from a document. (set: "" to value)
-     */
-    updateMany(updateBy: any, update: any, modifier: string): Promise<void>;
+     * @param update this uses the basic Mongoose updateOne
+     * @example
+     * // increase a specific value (here by 15):
+     * { $inc: { popularity: 15 } }
+     * //
+     * @example
+     * // or add element to a list:
+     * { $push: { reactions: this.newReaction }
+     * // or add multiple elements to a list
+     * { $push: { schedule: {$each: [ monday, tuesday, wednesday ] } } }
+     * //
+     * @example
+     * // or all at once
+     * {
+     *   $inc: { popularity: this.newVote.amount },
+     *   emailVerified: true,
+     *   $push: { reactions: this.newReaction }
+     * }
+     * // further tools (syntax matches with $inc):
+     * $currentDate: // Sets the value of a field to current date, either as a Date or a Timestamp.
+     * $min:         // Only updates the field if the specified value is less than the existing field value.
+     * $max:         // Only updates the field if the specified value is greater than the existing field value.
+     * $mul:         // Multiplies the value of the field by the specified amount.
+     * $rename:      // Renames a field.
+     * $unset:       // Removes the specified field from a document. (set: "" to value)
+     * //
+     */
+    updateMany(updateBy: any, update: any, modifier: string): Promise<T[]>;
     /**
      * builds and returns mongoose schema
      * @returns schema

package/lib/_services/dynamo-nts-db.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dynamo-nts-db.service.d.ts","sourceRoot":"","sources":["../../src/_services/dynamo-nts-db.service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AAErC,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAA8C,MAAM,uBAAuB,CAAC;AAE1H;;GAEG;AACH,qBAAa,mBAAmB,CAAC,CAAC,SAAS,eAAe;IAc/C,UAAU,EAAE,oBAAoB;IAbzC,SAAS,6DAA4D;IAErE,OAAO,CAAC,WAAW,CAAS;IAE5B,mBAAmB,SAA2F;IAE9G;;;;;OAKG;gBAEM,UAAU,EAAE,oBAAoB;IAKzC;;;;OAIG;IACG,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAyCtD;;;;OAIG;IACG,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAmCvD;;;;OAIG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IA2BzC;;;;OAIG;IACG,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAkC7D;;;;OAIG;IACG,yBAAyB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAkCnE;;;;OAIG;IACG,0BAA0B,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IA6B7D;;;;;;OAMG;IACG,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,qBAAqB,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAgFlF;;;;;;;;;;;OAWG;IAqBH;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC;IA2B5B;;;OAGG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAa/C;;;OAGG;IACG,wBAAwB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA4BnE;;;;;;;;;;;;;;;;;;OAkBG;IACG,OAAO,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAwBtC;;;;;;;;;;;;;;;;;OAiBG;IACG,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IA2BrC;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IA8B3F;;;;;OAKG;IACG,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IA+B9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,SAAS,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAe5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,UAAU,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB7E;;;OAGG;IACH,OAAO,CAAC,SAAS;IAajB;;;;OAIG;IACH,OAAO,CAAC,gCAAgC;IAoCxC,OAAO,CAAC,SAAS;IAuBjB;;;;OAIG;IACH,OAAO,CAAC,0BAA0B;IASlC;;OAEG;IACH,OAAO,CAAC,6BAA6B;CAOtC"}
+{"version":3,"file":"dynamo-nts-db.service.d.ts","sourceRoot":"","sources":["../../src/_services/dynamo-nts-db.service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AAErC,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAA8C,MAAM,uBAAuB,CAAC;AAE1H;;GAEG;AACH,qBAAa,mBAAmB,CAAC,CAAC,SAAS,eAAe;IAc/C,UAAU,EAAE,oBAAoB;IAbzC,SAAS,6DAA4D;IAErE,OAAO,CAAC,WAAW,CAAS;IAE5B,mBAAmB,SAA2F;IAE9G;;;;;OAKG;gBAEM,UAAU,EAAE,oBAAoB;IAKzC;;;;OAIG;IACG,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAuCtD;;;;OAIG;IACG,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAqCvD;;;;OAIG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAyBzC;;;;OAIG;IACG,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAmC7D;;;;OAIG;IACG,yBAAyB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAmCnE;;;;OAIG;IACG,0BAA0B,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAmC7D;;;;;;OAMG;IACG,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,qBAAqB,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAwFlF;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC;IAuB5B;;;OAGG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAa/C;;;OAGG;IACG,wBAAwB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BnE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,OAAO,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAyBtC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAyBrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IA4B3F;;;;;OAKG;IACG,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAoC9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACG,SAAS,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAqCzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACG,UAAU,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAmC5E;;;OAGG;IACH,OAAO,CAAC,SAAS;IAajB;;;;OAIG;IACH,OAAO,CAAC,gCAAgC;IAoCxC,OAAO,CAAC,SAAS;IAuBjB;;;;OAIG;IACH,OAAO,CAAC,0BAA0B;IASlC;;OAEG;IACH,OAAO,CAAC,6BAA6B;CAOtC"}