@decaf-ts/decorator-validation 1.7.1 → 1.7.2

package/lib/validation/decorators.d.ts

@@ -10,7 +10,7 @@ import { ModelConstructor } from "../model/types";
  * @return {PropertyDecorator} A decorator function that can be applied to class properties
  *
  * @function required
- * @category Decorators
+ * @category Property Decorators
  *
  * @example
  * ```typescript
@@ -35,7 +35,7 @@ export declare function required(message?: string): (target: any, propertyKey?:
  * @return {PropertyDecorator} A decorator function that can be applied to class properties
  *
  * @function min
- * @category Decorators
+ * @category Property Decorators
  *
  * @example
  * ```typescript
@@ -57,7 +57,7 @@ export declare function min(value: number | Date | string, message?: string): (t
  * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#MAX}
  *
  * @function max
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function max(value: number | Date | string, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
 /**
@@ -68,7 +68,7 @@ export declare function max(value: number | Date | string, message?: string): (t
  * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#STEP}
  *
  * @function step
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function step(value: number, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
 /**
@@ -79,7 +79,7 @@ export declare function step(value: number, message?: string): (target: any, pro
  * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#MIN_LENGTH}
  *
  * @function minlength
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function minlength(value: number, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
 /**
@@ -90,7 +90,7 @@ export declare function minlength(value: number, message?: string): (target: any
  * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#MAX_LENGTH}
  *
  * @function maxlength
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function maxlength(value: number, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
 /**
@@ -101,7 +101,7 @@ export declare function maxlength(value: number, message?: string): (target: any
  * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#PATTERN}
  *
  * @function pattern
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function pattern(value: RegExp | string, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
 /**
@@ -111,7 +111,7 @@ export declare function pattern(value: RegExp | string, message?: string): (targ
  * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#EMAIL}
  *
  * @function email
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function email(message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
 /**
@@ -121,7 +121,7 @@ export declare function email(message?: string): (target: any, propertyKey?: any
  * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#URL}
  *
  * @function url
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function url(message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
 /**
@@ -132,7 +132,7 @@ export declare function url(message?: string): (target: any, propertyKey?: any,
  * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES#TYPE}
  *
  * @function type
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function type(types: string[] | string, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
 /**
@@ -146,7 +146,7 @@ export declare function type(types: string[] | string, message?: string): (targe
  *
  * @function date
  *
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function date(format?: string, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
 /**
@@ -158,7 +158,7 @@ export declare function date(format?: string, message?: string): (target: any, p
  *
  * @function password
  *
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function password(pattern?: RegExp, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
 /**
@@ -171,7 +171,7 @@ export declare function password(pattern?: RegExp, message?: string): (target: a
  *
  * @function list
  *
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function list(clazz: ModelConstructor<any> | ModelConstructor<any>[], collection?: "Array" | "Set", message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
 /**
@@ -183,7 +183,7 @@ export declare function list(clazz: ModelConstructor<any> | ModelConstructor<any
  *
  * @function set
  *
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function set(clazz: ModelConstructor<any>, message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
 /**
@@ -196,8 +196,7 @@ export declare function set(clazz: ModelConstructor<any>, message?: string): (ta
  * @returns {PropertyDecorator} A property decorator used to register the equality validation metadata.
  *
  * @function eq
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function eq(propertyToCompare: string, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
 /**
@@ -210,8 +209,7 @@ export declare function eq(propertyToCompare: string, message?: string): (target
  * @returns {PropertyDecorator} A property decorator used to register the difference validation metadata.
  *
  * @function diff
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function diff(propertyToCompare: string, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
 /**
@@ -224,8 +222,7 @@ export declare function diff(propertyToCompare: string, message?: string): (targ
  * @returns {PropertyDecorator} A property decorator used to register the less than validation metadata.
  *
  * @function lt
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function lt(propertyToCompare: string, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
 /**
@@ -238,8 +235,7 @@ export declare function lt(propertyToCompare: string, message?: string): (target
  * @returns {PropertyDecorator} A property decorator used to register the less than or equal validation metadata.
  *
  * @function lte
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function lte(propertyToCompare: string, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
 /**
@@ -252,8 +248,7 @@ export declare function lte(propertyToCompare: string, message?: string): (targe
  * @returns {PropertyDecorator} A property decorator used to register the greater than validation metadata.
  *
  * @function gt
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function gt(propertyToCompare: string, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;
 /**
@@ -266,7 +261,6 @@ export declare function gt(propertyToCompare: string, message?: string): (target
  * @returns {PropertyDecorator} A property decorator used to register the greater than or equal validation metadata.
  *
  * @function gte
- * @memberOf module:decorator-validation.Decorators.Validation
- * @category Decorators
+ * @category Property Decorators
  */
 export declare function gte(propertyToCompare: string, message?: string): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/decorator-validation",
-  "version": "1.7.1",
+  "version": "1.7.2",
   "description": "simple decorator based validation engine",
   "type": "module",
   "exports": {