@marmot/node-validate - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1-alpha.0

dist/decorator/alias.d.ts

 import { IPropOptions } from './prop';
 import { IArgOptions } from './arg';
 import { ArrayItems, ArrayItem as ArrayItemType } from '../model/common';
-export declare type PropDecorator<T> = (options: T) => (target: any, propertyKey: string) => void;
-export declare const PropAlias: <T>(Decorator: PropDecorator<T>, attr: T, options?: IPropOptions | undefined) => (target: any, propertyKey: string) => void;
-export declare type NullablePropOptions = IPropOptions;
-export declare const NullableProp: (options?: IPropOptions | undefined) => (target: any, propertyKey: string) => void;
-export declare type EnumPropOptions<T extends Array<any>> = IPropOptions & {
+export type PropDecorator<T> = (options: T) => (target: any, propertyKey: string) => void;
+export declare const PropAlias: <T>(Decorator: PropDecorator<T>, attr: T, options?: IPropOptions) => (target: any, propertyKey: string) => void;
+export type NullablePropOptions = IPropOptions;
+export declare const NullableProp: (options?: NullablePropOptions) => (target: any, propertyKey: string) => void;
+export type EnumPropOptions<T extends Array<any>> = IPropOptions & {
     values: T;
 };
 export declare const EnumProp: <T extends any[]>({ values, ...options }: EnumPropOptions<T>) => (target: any, propertyKey: string) => void;
-export declare type ArrayItemPropOptions = IPropOptions & {
+export type ArrayItemPropOptions = IPropOptions & {
     items: ArrayItems;
 };
 export declare const ArrayItemProp: ({ items, ...options }: ArrayItemPropOptions) => (target: any, propertyKey: string) => void;
-export declare type ArrayTuplePropOptions = IPropOptions & {
+export type ArrayTuplePropOptions = IPropOptions & {
     items: ArrayItemType[];
 };
 export declare const ArrayTupleProp: ({ items, ...options }: ArrayTuplePropOptions) => (target: any, propertyKey: string) => void;
-export declare type ConstPropOptions<T> = IPropOptions & {
+export type ConstPropOptions<T> = IPropOptions & {
     value: T;
 };
 export declare const ConstProp: <T>({ value, ...options }: ConstPropOptions<T>) => (target: any, propertyKey: string) => void;
-export declare type MaximumPropOptions = IPropOptions & {
+export type MaximumPropOptions = IPropOptions & {
     maximum: number;
 };
 export declare const MaximumProp: ({ maximum, ...options }: MaximumPropOptions) => (target: any, propertyKey: string) => void;
-export declare type MinimumPropOptions = IPropOptions & {
+export type MinimumPropOptions = IPropOptions & {
     minimum: number;
 };
 export declare const MinimumProp: ({ minimum, ...options }: MinimumPropOptions) => (target: any, propertyKey: string) => void;
-export declare type ExclusiveMaximumPropOptions = IPropOptions & {
+export type ExclusiveMaximumPropOptions = IPropOptions & {
     exclusiveMaximum: number;
 };
 export declare const ExclusiveMaximumProp: ({ exclusiveMaximum, ...options }: ExclusiveMaximumPropOptions) => (target: any, propertyKey: string) => void;
-export declare type ExclusiveMinimumPropOptions = IPropOptions & {
+export type ExclusiveMinimumPropOptions = IPropOptions & {
     exclusiveMinimum: number;
 };
 export declare const ExclusiveMinimumProp: ({ exclusiveMinimum, ...options }: ExclusiveMinimumPropOptions) => (target: any, propertyKey: string) => void;
-export declare type MultipleOfPropOptions = IPropOptions & {
+export type MultipleOfPropOptions = IPropOptions & {
     multipleOf: number;
 };
 export declare const MultipleOfProp: ({ multipleOf, ...options }: MultipleOfPropOptions) => (target: any, propertyKey: string) => void;
-export declare type MaxLengthPropOptions = IPropOptions & {
+export type MaxLengthPropOptions = IPropOptions & {
     maxLength: number;
 };
 export declare const MaxLengthProp: ({ maxLength, ...options }: MaxLengthPropOptions) => (target: any, propertyKey: string) => void;
-export declare type MinLengthPropOptions = IPropOptions & {
+export type MinLengthPropOptions = IPropOptions & {
     minLength: number;
 };
 export declare const MinLengthProp: ({ minLength, ...options }: MinLengthPropOptions) => (target: any, propertyKey: string) => void;
-export declare type PatternPropOptions = IPropOptions & {
+export type PatternPropOptions = IPropOptions & {
     pattern: string;
 };
 export declare const PatternProp: ({ pattern, ...options }: PatternPropOptions) => (target: any, propertyKey: string) => void;
-export declare type FormatPropOptions = IPropOptions & {
+export type FormatPropOptions = IPropOptions & {
     format: string;
 };
 export declare const FormatProp: ({ format, ...options }: FormatPropOptions) => (target: any, propertyKey: string) => void;
-export declare type MaxItemsPropOptions = IPropOptions & {
+export type MaxItemsPropOptions = IPropOptions & {
     maxItems: number;
 };
 export declare const MaxItemsProp: ({ maxItems, ...options }: MaxItemsPropOptions) => (target: any, propertyKey: string) => void;
-export declare type MinItemsPropOptions = IPropOptions & {
+export type MinItemsPropOptions = IPropOptions & {
     minItems: number;
 };
 export declare const MinItemsProp: ({ minItems, ...options }: MinItemsPropOptions) => (target: any, propertyKey: string) => void;
-export declare type TrimPropOptions = IPropOptions;
-export declare const TrimProp: (options?: IPropOptions | undefined) => (target: any, propertyKey: string) => void;
-export declare type TrimStartPropOptions = IPropOptions;
-export declare const TrimStartProp: (options?: IPropOptions | undefined) => (target: any, propertyKey: string) => void;
-export declare type TrimEndPropOptions = IPropOptions;
-export declare const TrimEndProp: (options?: IPropOptions | undefined) => (target: any, propertyKey: string) => void;
-export declare type ToLowerCasePropOptions = IPropOptions;
-export declare const ToLowerCaseProp: (options?: IPropOptions | undefined) => (target: any, propertyKey: string) => void;
-export declare type ToUpperCasePropOptions = IPropOptions;
-export declare const ToUpperCaseProp: (options?: IPropOptions | undefined) => (target: any, propertyKey: string) => void;
-export declare type ArgDecorator<T> = (options: T) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare const ArgAlias: <T>(Decorator: ArgDecorator<T>, attr: T, options?: IArgOptions | undefined) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type NullableArgOptions = IArgOptions;
-export declare const NullableArg: (options?: IArgOptions | undefined) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type EnumArgOptions<T extends Array<any>> = IArgOptions & {
+export type TrimPropOptions = IPropOptions;
+export declare const TrimProp: (options?: TrimPropOptions) => (target: any, propertyKey: string) => void;
+export type TrimStartPropOptions = IPropOptions;
+export declare const TrimStartProp: (options?: TrimStartPropOptions) => (target: any, propertyKey: string) => void;
+export type TrimEndPropOptions = IPropOptions;
+export declare const TrimEndProp: (options?: TrimEndPropOptions) => (target: any, propertyKey: string) => void;
+export type ToLowerCasePropOptions = IPropOptions;
+export declare const ToLowerCaseProp: (options?: ToLowerCasePropOptions) => (target: any, propertyKey: string) => void;
+export type ToUpperCasePropOptions = IPropOptions;
+export declare const ToUpperCaseProp: (options?: ToUpperCasePropOptions) => (target: any, propertyKey: string) => void;
+export type ArgDecorator<T> = (options: T) => (target: any, propertyKey: string, parameterIndex: number) => void;
+export declare const ArgAlias: <T>(Decorator: ArgDecorator<T>, attr: T, options?: IArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
+export type NullableArgOptions = IArgOptions;
+export declare const NullableArg: (options?: NullableArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
+export type EnumArgOptions<T extends Array<any>> = IArgOptions & {
     values: T;
 };
 export declare const EnumArg: <T extends any[]>({ values, ...options }: EnumArgOptions<T>) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type ArrayItemArgOptions = IArgOptions & {
+export type ArrayItemArgOptions = IArgOptions & {
     items: ArrayItems;
 };
 export declare const ArrayItemArg: ({ items, ...options }: ArrayItemArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type ArrayTupleArgOptions = IPropOptions & {
+export type ArrayTupleArgOptions = IArgOptions & {
     items: ArrayItemType[];
 };
 export declare const ArrayTupleArg: ({ items, ...options }: ArrayTupleArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type ConstArgOptions<T> = IArgOptions & {
+export type ConstArgOptions<T> = IArgOptions & {
     value: T;
 };
 export declare const ConstArg: <T>({ value, ...options }: ConstArgOptions<T>) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type MaximumArgOptions = IArgOptions & {
+export type MaximumArgOptions = IArgOptions & {
     maximum: number;
 };
 export declare const MaximumArg: ({ maximum, ...options }: MaximumArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type MinimumArgOptions = IArgOptions & {
+export type MinimumArgOptions = IArgOptions & {
     minimum: number;
 };
 export declare const MinimumArg: ({ minimum, ...options }: MinimumArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type ExclusiveMaximumArgOptions = IArgOptions & {
+export type ExclusiveMaximumArgOptions = IArgOptions & {
     exclusiveMaximum: number;
 };
 export declare const ExclusiveMaximumArg: ({ exclusiveMaximum, ...options }: ExclusiveMaximumArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type ExclusiveMinimumArgOptions = IArgOptions & {
+export type ExclusiveMinimumArgOptions = IArgOptions & {
     exclusiveMinimum: number;
 };
 export declare const ExclusiveMinimumArg: ({ exclusiveMinimum, ...options }: ExclusiveMinimumArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type MultipleOfArgOptions = IArgOptions & {
+export type MultipleOfArgOptions = IArgOptions & {
     multipleOf: number;
 };
 export declare const MultipleOfArg: ({ multipleOf, ...options }: MultipleOfArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type MaxLengthArgOptions = IArgOptions & {
+export type MaxLengthArgOptions = IArgOptions & {
     maxLength: number;
 };
 export declare const MaxLengthArg: ({ maxLength, ...options }: MaxLengthArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type MinLengthArgOptions = IArgOptions & {
+export type MinLengthArgOptions = IArgOptions & {
     minLength: number;
 };
 export declare const MinLengthArg: ({ minLength, ...options }: MinLengthArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type PatternArgOptions = IArgOptions & {
+export type PatternArgOptions = IArgOptions & {
     pattern: string;
 };
 export declare const PatternArg: ({ pattern, ...options }: PatternArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type FormatArgOptions = IArgOptions & {
+export type FormatArgOptions = IArgOptions & {
     format: string;
 };
 export declare const FormatArg: ({ format, ...options }: FormatArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type MaxItemsArgOptions = IArgOptions & {
+export type MaxItemsArgOptions = IArgOptions & {
     maxItems: number;
 };
 export declare const MaxItemsArg: ({ maxItems, ...options }: MaxItemsArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type MinItemsArgOptions = IArgOptions & {
+export type MinItemsArgOptions = IArgOptions & {
     minItems: number;
 };
 export declare const MinItemsArg: ({ minItems, ...options }: MinItemsArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type TrimArgOptions = IArgOptions;
-export declare const TrimArg: (options?: IArgOptions | undefined) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type TrimStartArgOptions = IArgOptions;
-export declare const TrimStartArg: (options?: IArgOptions | undefined) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type TrimEndArgOptions = IArgOptions;
-export declare const TrimEndArg: (options?: IArgOptions | undefined) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type ToLowerCaseArgOptions = IArgOptions;
-export declare const ToLowerCaseArg: (options?: IArgOptions | undefined) => (target: any, propertyKey: string, parameterIndex: number) => void;
-export declare type ToUpperCaseArgOptions = IArgOptions;
-export declare const ToUpperCaseArg: (options?: IArgOptions | undefined) => (target: any, propertyKey: string, parameterIndex: number) => void;
+export type TrimArgOptions = IArgOptions;
+export declare const TrimArg: (options?: TrimArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
+export type TrimStartArgOptions = IArgOptions;
+export declare const TrimStartArg: (options?: TrimStartArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
+export type TrimEndArgOptions = IArgOptions;
+export declare const TrimEndArg: (options?: TrimEndArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
+export type ToLowerCaseArgOptions = IArgOptions;
+export declare const ToLowerCaseArg: (options?: ToLowerCaseArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;
+export type ToUpperCaseArgOptions = IArgOptions;
+export declare const ToUpperCaseArg: (options?: ToUpperCaseArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;

dist/decorator/arg.d.ts

@@ -0,7 +1,8 @@
+import { SchemaType } from '../model/ajv';
 import { MetadataClass } from '../util/metadata/metadataUtil';
 export interface IArgOptions {
     name?: string;
-    type?: string | MetadataClass;
+    type?: SchemaType | SchemaType[] | MetadataClass;
     default?: any;
 }
 export declare const Arg: (options?: IArgOptions) => (target: any, propertyKey: string, parameterIndex: number) => void;

dist/decorator/arg.js

@@ -26,3 +26,3 @@ "use strict";
         }
-        if (typeof type === 'string') {
+        if (typeof type === 'string' || Array.isArray(type)) {
             schema.properties[name] = { type, default: defaultValue };
@@ -38,2 +38,2 @@ return;
 exports.Arg = Arg;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXJnLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2RlY29yYXRvci9hcmcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQ0EsbURBQWdEO0FBQ2hELG1EQUFnRDtBQUNoRCwrQ0FBNEM7QUFRckMsTUFBTSxHQUFHLEdBQUcsQ0FBQyxVQUF1QixFQUFFLEVBQUUsRUFBRTtJQUMvQyxPQUFPLENBQUMsTUFBVyxFQUFFLFdBQW1CLEVBQUUsY0FBc0IsRUFBRSxFQUFFO1FBQ2xFLElBQUksRUFBRSxJQUFJLEVBQUUsSUFBSSxFQUFFLE9BQU8sRUFBRSxZQUFZLEVBQUUsR0FBRyxPQUFPLENBQUM7UUFDcEQsTUFBTSxNQUFNLEdBQUcsdUJBQVUsQ0FBQyxxQkFBcUIsQ0FBQyxNQUFNLENBQUMsV0FBVyxFQUFFLFdBQVcsQ0FBQyxDQUFDO1FBQ2pGLElBQUksQ0FBQyxJQUFJLEVBQUU7WUFDVCxJQUFJLEdBQUcsdUJBQVUsQ0FBQyxnQkFBZ0IsQ0FBQyxNQUFNLENBQUMsV0FBVyxDQUFDLEVBQUUsY0FBYyxDQUFDLENBQUM7U0FDekU7UUFDRCxJQUFJLENBQUMsSUFBSSxFQUFFO1lBQ1QsMkJBQTJCO1lBQzNCLE1BQU0sWUFBWSxHQUFHLE9BQU8sQ0FBQyxXQUFXLENBQUMsbUJBQW1CLEVBQUUsTUFBTSxFQUFFLFdBQVcsQ0FBQyxDQUFDO1lBQ25GLElBQUksR0FBRyxtQkFBUSxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUMsY0FBYyxDQUFDLENBQUMsQ0FBQztZQUNuRCxJQUFJLENBQUMsSUFBSSxFQUFFO2dCQUNULE1BQU0sSUFBSSxLQUFLLENBQUMsOEJBQThCLElBQUksZ0JBQWdCLE1BQU0sQ0FBQyxXQUFXLENBQUMsSUFBSSxJQUFJLFdBQVcsRUFBRSxDQUFDLENBQUM7YUFDN0c7U0FDRjtRQUNELHVCQUFVLENBQUMsMkJBQTJCLENBQUMsTUFBTSxDQUFDLFdBQVcsRUFBRSxXQUFXLENBQUMsQ0FBQyxHQUFHLENBQUMsY0FBYyxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQ2xHLElBQUksQ0FBQyxNQUFNLENBQUMsUUFBUyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsRUFBRTtZQUNwQyxNQUFNLENBQUMsUUFBUyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztTQUM3QjtRQUNELElBQUksT0FBTyxJQUFJLEtBQUssUUFBUSxFQUFFO1lBQzVCLE1BQU0sQ0FBQyxVQUFXLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxJQUFJLEVBQUUsT0FBTyxFQUFFLFlBQVksRUFBRSxDQUFDO1lBQzNELE9BQU87U0FDUjtRQUNELE1BQU0sQ0FBQyxVQUFXLENBQUMsSUFBSSxDQUFDLEdBQUcsdUJBQVUsQ0FBQyxlQUFlLENBQUMsSUFBSSxDQUFFLENBQUM7UUFDN0QsSUFBSSxZQUFZLEVBQUU7WUFDaEIsTUFBTSxDQUFDLFVBQVcsQ0FBQyxJQUFJLENBQUMsQ0FBQyxPQUFPLEdBQUcsWUFBWSxDQUFDO1NBQ2pEO0lBQ0gsQ0FBQyxDQUFDO0FBQ0osQ0FBQyxDQUFDO0FBNUJXLFFBQUEsR0FBRyxPQTRCZCJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXJnLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2RlY29yYXRvci9hcmcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBRUEsbURBQWdEO0FBQ2hELG1EQUFnRDtBQUNoRCwrQ0FBNEM7QUFRckMsTUFBTSxHQUFHLEdBQUcsQ0FBQyxVQUF1QixFQUFFLEVBQUUsRUFBRTtJQUMvQyxPQUFPLENBQUMsTUFBVyxFQUFFLFdBQW1CLEVBQUUsY0FBc0IsRUFBRSxFQUFFO1FBQ2xFLElBQUksRUFBRSxJQUFJLEVBQUUsSUFBSSxFQUFFLE9BQU8sRUFBRSxZQUFZLEVBQUUsR0FBRyxPQUFPLENBQUM7UUFDcEQsTUFBTSxNQUFNLEdBQUcsdUJBQVUsQ0FBQyxxQkFBcUIsQ0FBQyxNQUFNLENBQUMsV0FBVyxFQUFFLFdBQVcsQ0FBQyxDQUFDO1FBQ2pGLElBQUksQ0FBQyxJQUFJLEVBQUU7WUFDVCxJQUFJLEdBQUcsdUJBQVUsQ0FBQyxnQkFBZ0IsQ0FBQyxNQUFNLENBQUMsV0FBVyxDQUFDLEVBQUUsY0FBYyxDQUFDLENBQUM7U0FDekU7UUFDRCxJQUFJLENBQUMsSUFBSSxFQUFFO1lBQ1QsMkJBQTJCO1lBQzNCLE1BQU0sWUFBWSxHQUFHLE9BQU8sQ0FBQyxXQUFXLENBQUMsbUJBQW1CLEVBQUUsTUFBTSxFQUFFLFdBQVcsQ0FBQyxDQUFDO1lBQ25GLElBQUksR0FBRyxtQkFBUSxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUMsY0FBYyxDQUFDLENBQUMsQ0FBQztZQUNuRCxJQUFJLENBQUMsSUFBSSxFQUFFO2dCQUNULE1BQU0sSUFBSSxLQUFLLENBQUMsOEJBQThCLElBQUksZ0JBQWdCLE1BQU0sQ0FBQyxXQUFXLENBQUMsSUFBSSxJQUFJLFdBQVcsRUFBRSxDQUFDLENBQUM7YUFDN0c7U0FDRjtRQUNELHVCQUFVLENBQUMsMkJBQTJCLENBQUMsTUFBTSxDQUFDLFdBQVcsRUFBRSxXQUFXLENBQUMsQ0FBQyxHQUFHLENBQUMsY0FBYyxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQ2xHLElBQUksQ0FBQyxNQUFNLENBQUMsUUFBUyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsRUFBRTtZQUNwQyxNQUFNLENBQUMsUUFBUyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztTQUM3QjtRQUNELElBQUksT0FBTyxJQUFJLEtBQUssUUFBUSxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEVBQUU7WUFDbkQsTUFBTSxDQUFDLFVBQVcsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLElBQUksRUFBRSxPQUFPLEVBQUUsWUFBWSxFQUFFLENBQUM7WUFDM0QsT0FBTztTQUNSO1FBQ0QsTUFBTSxDQUFDLFVBQVcsQ0FBQyxJQUFJLENBQUMsR0FBRyx1QkFBVSxDQUFDLGVBQWUsQ0FBQyxJQUFJLENBQUUsQ0FBQztRQUM3RCxJQUFJLFlBQVksRUFBRTtZQUNoQixNQUFNLENBQUMsVUFBVyxDQUFDLElBQUksQ0FBQyxDQUFDLE9BQU8sR0FBRyxZQUFZLENBQUM7U0FDakQ7SUFDSCxDQUFDLENBQUM7QUFDSixDQUFDLENBQUM7QUE1QlcsUUFBQSxHQUFHLE9BNEJkIn0=

dist/decorator/attribute.d.ts

 import { SchemaAttribute } from '../model/ajv';
 import { ArrayItems, ArrayItem as ArrayItemType } from '../model/common';
-export declare const Nullable: () => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const Enum: <T extends any[]>(values: T) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const ArrayItem: (items: ArrayItems) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const ArrayTuple: (items: ArrayItemType[]) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const createAttributeDecorator: <T = number>(attribute: SchemaAttribute) => (value: T) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const createTransformDecorator: (op: 'trim' | 'trimStart' | 'trimEnd' | 'toLowerCase' | 'toUpperCase') => () => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const Const: <T>(value: T) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const Maximum: (value: number) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const Minimum: (value: number) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const ExclusiveMaximum: (value: number) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const ExclusiveMinimum: (value: number) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const MultipleOf: (value: number) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const MaxLength: (value: number) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const MinLength: (value: number) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const Pattern: (value: string) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const Format: (value: string) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const MaxItems: (value: number) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const MinItems: (value: number) => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const Trim: () => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const TrimStart: () => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const TrimEnd: () => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const ToLowerCase: () => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
-export declare const ToUpperCase: () => (target: any, propertyKey: string, parameterIndex?: number | undefined) => void;
+export declare const Nullable: () => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const Enum: <T extends any[]>(values: T) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const ArrayItem: (items: ArrayItems) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const ArrayTuple: (items: ArrayItemType[]) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const createAttributeDecorator: <T = number>(attribute: SchemaAttribute) => (value: T) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const createTransformDecorator: (op: 'trim' | 'trimStart' | 'trimEnd' | 'toLowerCase' | 'toUpperCase') => () => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const Const: <T>(value: T) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const Maximum: (value: number) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const Minimum: (value: number) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const ExclusiveMaximum: (value: number) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const ExclusiveMinimum: (value: number) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const MultipleOf: (value: number) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const MaxLength: (value: number) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const MinLength: (value: number) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const Pattern: (value: string) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const Format: (value: string) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const MaxItems: (value: number) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const MinItems: (value: number) => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const Trim: () => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const TrimStart: () => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const TrimEnd: () => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const ToLowerCase: () => (target: any, propertyKey: string, parameterIndex?: number) => void;
+export declare const ToUpperCase: () => (target: any, propertyKey: string, parameterIndex?: number) => void;

dist/decorator/prop.d.ts

 import { SchemaType } from '../model/ajv';
 import { MetadataClass } from '../util/metadata/metadataUtil';
 export interface IPropOptions {
-    type?: SchemaType | MetadataClass;
+    type?: SchemaType | SchemaType[] | MetadataClass;
     default?: any;
@@ -6,0 +6,0 @@ message?: string;

dist/decorator/prop.js

@@ -28,3 +28,3 @@ "use strict";
         }
-        if (typeof type === 'string') {
+        if (typeof type === 'string' || Array.isArray(type)) {
             schema.properties[propertyKey] = { type };
@@ -41,2 +41,2 @@ }
 exports.Prop = Prop;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvcC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9kZWNvcmF0b3IvcHJvcC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFDQSwrQ0FBNEM7QUFFNUMsbURBQWdEO0FBUXpDLE1BQU0sSUFBSSxHQUFHLENBQUMsVUFBd0IsRUFBRSxFQUFFLEVBQUU7SUFDakQsT0FBTyxDQUFDLE1BQVcsRUFBRSxXQUFtQixFQUFFLEVBQUU7O1FBQzFDLElBQUksRUFBRSxJQUFJLEVBQUUsT0FBTyxFQUFFLFlBQVksRUFBRSxPQUFPLEVBQUUsR0FBRyxPQUFPLENBQUM7UUFDdkQsTUFBTSxNQUFNLEdBQUcsdUJBQVUsQ0FBQyxxQkFBcUIsQ0FBQyxNQUFNLENBQUMsV0FBVyxDQUFDLENBQUM7UUFDcEUsSUFBSSxDQUFDLElBQUksRUFBRTtZQUNULDJCQUEyQjtZQUMzQixNQUFNLFdBQVcsR0FBRyxPQUFPLENBQUMsV0FBVyxDQUFDLGFBQWEsRUFBRSxNQUFNLEVBQUUsV0FBVyxDQUFDLENBQUM7WUFDNUUsSUFBSSxHQUFHLG1CQUFRLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDO1lBQ2xDLElBQUksQ0FBQyxJQUFJLEVBQUU7Z0JBQ1QsTUFBTSxJQUFJLEtBQUssQ0FBQyw4QkFBOEIsV0FBVyxhQUFhLE1BQU0sQ0FBQyxXQUFXLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQzthQUNsRztTQUNGO1FBQ0QsSUFBSSxPQUFPLEVBQUU7WUFDWCxJQUFJLENBQUMsQ0FBQSxNQUFBLE1BQU0sQ0FBQyxZQUFZLDBDQUFFLFVBQVUsQ0FBQSxFQUFFO2dCQUNwQyxNQUFNLENBQUMsWUFBWSxHQUFHLEVBQUUsVUFBVSxFQUFFLEVBQUUsRUFBRSxDQUFDO2FBQzFDO1lBQ0QsTUFBTSxDQUFDLFlBQVksQ0FBQyxVQUFVLENBQUMsV0FBVyxDQUFDLEdBQUcsT0FBTyxDQUFDO1NBQ3ZEO1FBQ0QsSUFBSSxDQUFDLE1BQU0sQ0FBQyxRQUFTLENBQUMsUUFBUSxDQUFDLFdBQVcsQ0FBQyxFQUFFO1lBQzNDLE1BQU0sQ0FBQyxRQUFTLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDO1NBQ3BDO1FBQ0QsSUFBSSxPQUFPLElBQUksS0FBSyxRQUFRLEVBQUU7WUFDNUIsTUFBTSxDQUFDLFVBQVcsQ0FBQyxXQUFXLENBQUMsR0FBRyxFQUFFLElBQUksRUFBRSxDQUFDO1NBQzVDO2FBQU07WUFDTCxNQUFNLENBQUMsVUFBVyxDQUFDLFdBQVcsQ0FBQyxHQUFHLHVCQUFVLENBQUMsZUFBZSxDQUFDLElBQUksQ0FBRSxDQUFDO1NBQ3JFO1FBQ0QsSUFBSSxZQUFZLEtBQUssU0FBUyxFQUFFO1lBQzlCLE1BQU0sQ0FBQyxVQUFXLENBQUMsV0FBVyxDQUFDLENBQUMsT0FBTyxHQUFHLFlBQVksQ0FBQztTQUN4RDtJQUNILENBQUMsQ0FBQztBQUNKLENBQUMsQ0FBQztBQTlCVyxRQUFBLElBQUksUUE4QmYifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvcC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9kZWNvcmF0b3IvcHJvcC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFDQSwrQ0FBNEM7QUFFNUMsbURBQWdEO0FBUXpDLE1BQU0sSUFBSSxHQUFHLENBQUMsVUFBd0IsRUFBRSxFQUFFLEVBQUU7SUFDakQsT0FBTyxDQUFDLE1BQVcsRUFBRSxXQUFtQixFQUFFLEVBQUU7O1FBQzFDLElBQUksRUFBRSxJQUFJLEVBQUUsT0FBTyxFQUFFLFlBQVksRUFBRSxPQUFPLEVBQUUsR0FBRyxPQUFPLENBQUM7UUFDdkQsTUFBTSxNQUFNLEdBQUcsdUJBQVUsQ0FBQyxxQkFBcUIsQ0FBQyxNQUFNLENBQUMsV0FBVyxDQUFDLENBQUM7UUFDcEUsSUFBSSxDQUFDLElBQUksRUFBRTtZQUNULDJCQUEyQjtZQUMzQixNQUFNLFdBQVcsR0FBRyxPQUFPLENBQUMsV0FBVyxDQUFDLGFBQWEsRUFBRSxNQUFNLEVBQUUsV0FBVyxDQUFDLENBQUM7WUFDNUUsSUFBSSxHQUFHLG1CQUFRLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDO1lBQ2xDLElBQUksQ0FBQyxJQUFJLEVBQUU7Z0JBQ1QsTUFBTSxJQUFJLEtBQUssQ0FBQyw4QkFBOEIsV0FBVyxhQUFhLE1BQU0sQ0FBQyxXQUFXLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQzthQUNsRztTQUNGO1FBQ0QsSUFBSSxPQUFPLEVBQUU7WUFDWCxJQUFJLENBQUMsQ0FBQSxNQUFBLE1BQU0sQ0FBQyxZQUFZLDBDQUFFLFVBQVUsQ0FBQSxFQUFFO2dCQUNwQyxNQUFNLENBQUMsWUFBWSxHQUFHLEVBQUUsVUFBVSxFQUFFLEVBQUUsRUFBRSxDQUFDO2FBQzFDO1lBQ0QsTUFBTSxDQUFDLFlBQVksQ0FBQyxVQUFVLENBQUMsV0FBVyxDQUFDLEdBQUcsT0FBTyxDQUFDO1NBQ3ZEO1FBQ0QsSUFBSSxDQUFDLE1BQU0sQ0FBQyxRQUFTLENBQUMsUUFBUSxDQUFDLFdBQVcsQ0FBQyxFQUFFO1lBQzNDLE1BQU0sQ0FBQyxRQUFTLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDO1NBQ3BDO1FBQ0QsSUFBSSxPQUFPLElBQUksS0FBSyxRQUFRLElBQUksS0FBSyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsRUFBRTtZQUNuRCxNQUFNLENBQUMsVUFBVyxDQUFDLFdBQVcsQ0FBQyxHQUFHLEVBQUUsSUFBSSxFQUFFLENBQUM7U0FDNUM7YUFBTTtZQUNMLE1BQU0sQ0FBQyxVQUFXLENBQUMsV0FBVyxDQUFDLEdBQUcsdUJBQVUsQ0FBQyxlQUFlLENBQUMsSUFBSSxDQUFFLENBQUM7U0FDckU7UUFDRCxJQUFJLFlBQVksS0FBSyxTQUFTLEVBQUU7WUFDOUIsTUFBTSxDQUFDLFVBQVcsQ0FBQyxXQUFXLENBQUMsQ0FBQyxPQUFPLEdBQUcsWUFBWSxDQUFDO1NBQ3hEO0lBQ0gsQ0FBQyxDQUFDO0FBQ0osQ0FBQyxDQUFDO0FBOUJXLFFBQUEsSUFBSSxRQThCZiJ9

dist/decorator/validate.d.ts

@@ -0,4 +1,5 @@
+import { IValidateError } from '../model/common';
 export interface IValidateOptions {
-    onError?: (error: any) => void;
+    onError?: (error: IValidateError[]) => void;
 }
-export declare const Validate: (options?: IValidateOptions | undefined) => (target: any, propertyKey: string, descriptor: any) => void;
+export declare const Validate: (options?: IValidateOptions) => (target: any, propertyKey: string, descriptor: any) => void;

dist/model/ajv.d.ts

@@ -1,2 +0,2 @@
-export declare type SchemaType = 'number' | 'integer' | 'string' | 'boolean' | 'array' | 'object' | 'null' | string;
+export type SchemaType = 'number' | 'integer' | 'string' | 'boolean' | 'array' | 'object' | 'null' | string;
 export interface ISchema {
@@ -29,2 +29,2 @@ type: SchemaType | SchemaType[];
 }
-export declare type SchemaAttribute = 'const' | 'maximum' | 'minimum' | 'exclusiveMaximum' | 'exclusiveMinimum' | 'multipleOf' | 'maxLength' | 'minLength' | 'pattern' | 'format' | 'maxItems' | 'minItems';
+export type SchemaAttribute = 'const' | 'maximum' | 'minimum' | 'exclusiveMaximum' | 'exclusiveMinimum' | 'multipleOf' | 'maxLength' | 'minLength' | 'pattern' | 'format' | 'maxItems' | 'minItems';

dist/model/common.d.ts

@@ -6,4 +6,4 @@ import { ISchema, SchemaType } from './ajv';
 }
-export declare type ArrayItem = SchemaType | MetadataClass | IArrayItemSchema;
-export declare type ArrayItems = ArrayItem | ArrayItem[];
+export type ArrayItem = SchemaType | MetadataClass | IArrayItemSchema;
+export type ArrayItems = ArrayItem | ArrayItem[];
 export interface IValidateError {
@@ -10,0 +10,0 @@ field: string;

dist/util/messageUtil.js

@@ -32,3 +32,3 @@ "use strict";
             case 'pattern':
-                return this.error(e, `does not match pattern`);
+                return this.error(e, 'does not match pattern');
             case 'maxItems':
@@ -35,0 +35,0 @@ return this.error(e, `must have fewer than ${e.params.limit} items`);

dist/util/metadata/metadataUtil.d.ts

 import 'reflect-metadata';
-export declare type MetaDataKey = symbol | string;
-export declare type MetadataClass<T = object> = new (...args: any[]) => T;
+export type MetaDataKey = symbol | string;
+export type MetadataClass<T = object> = new (...args: any[]) => T;
 export declare class MetadataUtil {
@@ -5,0 +5,0 @@ static defineMetadata<T>(metadataKey: MetaDataKey, metadataValue: T, clazz: MetadataClass): void;

dist/util/schemaUtil.js

@@ -59,5 +59,6 @@ "use strict";
                 return item.items ? { ...item, items: this.arrayItemSchema(item.items) } : item;
-            default:
+            default: {
                 const schema = this.getObjectSchema(item);
                 return schema !== null && schema !== void 0 ? schema : { type: 'object' };
+            }
         }
@@ -67,2 +68,2 @@ }
 exports.SchemaUtil = SchemaUtil;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2NoZW1hVXRpbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy91dGlsL3NjaGVtYVV0aWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQ0Esd0VBQXFDO0FBQ3JDLDBEQUFzRTtBQUV0RSx1REFBb0Q7QUFDcEQsdUNBQW9DO0FBR3BDLE1BQWEsVUFBVTtJQUNyQixNQUFNLENBQUMsZUFBZSxDQUFDLEtBQW9CO1FBQ3pDLE9BQU8sMkJBQVksQ0FBQyxjQUFjLENBQVUsdUJBQVUsQ0FBQyxZQUFZLEVBQUUsS0FBSyxDQUFDLENBQUM7SUFDOUUsQ0FBQztJQUVELE1BQU0sQ0FBQyxxQkFBcUIsQ0FBQyxLQUFvQjtRQUMvQyxNQUFNLFdBQVcsR0FBRywyQkFBWSxDQUFDLGNBQWMsQ0FBVSx1QkFBVSxDQUFDLFlBQVksRUFBRSxLQUFLLENBQUMsQ0FBQztRQUN6RixJQUFJLENBQUMsV0FBVyxFQUFFO1lBQ2hCLE1BQU0sV0FBVyxHQUFHLDJCQUFZLENBQUMsV0FBVyxDQUFVLHVCQUFVLENBQUMsWUFBWSxFQUFFLEtBQUssQ0FBQyxDQUFDO1lBQ3RGLE1BQU0sZUFBZSxHQUFHLFdBQVcsQ0FBQyxDQUFDLENBQUMsSUFBQSwwQkFBSyxFQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsVUFBVSxFQUFFLEVBQUUsRUFBRSxRQUFRLEVBQUUsRUFBRSxFQUFFLENBQUM7WUFDNUcsMkJBQVksQ0FBQyxjQUFjLENBQUMsdUJBQVUsQ0FBQyxZQUFZLEVBQUUsZUFBZSxFQUFFLEtBQUssQ0FBQyxDQUFDO1NBQzlFO1FBQ0QsT0FBTywyQkFBWSxDQUFDLGNBQWMsQ0FBVSx1QkFBVSxDQUFDLFlBQVksRUFBRSxLQUFLLENBQUUsQ0FBQztJQUMvRSxDQUFDO0lBRUQsTUFBTSxDQUFDLGVBQWUsQ0FBQyxLQUFxQixFQUFFLFdBQW1COztRQUMvRCxPQUFPLE1BQUEsMkJBQVksQ0FBQyxjQUFjLENBQXVCLHVCQUFVLENBQUMsWUFBWSxFQUFFLEtBQUssQ0FBQywwQ0FBRSxHQUFHLENBQUMsV0FBVyxDQUFDLENBQUM7SUFDN0csQ0FBQztJQUVELE1BQU0sQ0FBQyxxQkFBcUIsQ0FBQyxLQUFxQixFQUFFLFdBQW1CO1FBQ3JFLE1BQU0sU0FBUyxHQUFHLDJCQUFZLENBQUMsa0JBQWtCLENBQWtCLHVCQUFVLENBQUMsWUFBWSxFQUFFLEtBQUssRUFBRSxJQUFJLEdBQUcsRUFBRSxDQUFDLENBQUM7UUFDOUcsT0FBTyxpQkFBTyxDQUFDLFVBQVUsQ0FBQyxTQUFTLEVBQUUsV0FBVyxFQUFFO1lBQ2hELElBQUksRUFBRSxRQUFRO1lBQ2QsVUFBVSxFQUFFLEVBQUU7WUFDZCxRQUFRLEVBQUUsRUFBRTtTQUNiLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFRCxNQUFNLENBQUMscUJBQXFCLENBQUMsS0FBb0IsRUFBRSxXQUFtQjs7UUFDcEUsT0FBTyxNQUFBLDJCQUFZLENBQUMsY0FBYyxDQUFtQyx1QkFBVSxDQUFDLGNBQWMsRUFBRSxLQUFLLENBQUMsMENBQUUsR0FBRyxDQUFDLFdBQVcsQ0FBQyxDQUFDO0lBQzNILENBQUM7SUFFRCxNQUFNLENBQUMsMkJBQTJCLENBQUMsS0FBb0IsRUFBRSxXQUFtQjtRQUMxRSxNQUFNLEdBQUcsR0FBRywyQkFBWSxDQUFDLGtCQUFrQixDQUE4Qix1QkFBVSxDQUFDLGNBQWMsRUFBRSxLQUFLLEVBQUUsSUFBSSxHQUFHLEVBQUUsQ0FBQyxDQUFDO1FBQ3RILE9BQU8saUJBQU8sQ0FBQyxVQUFVLENBQThCLEdBQUcsRUFBRSxXQUFXLEVBQUUsSUFBSSxHQUFHLEVBQUUsQ0FBQyxDQUFDO0lBQ3RGLENBQUM7SUFFRCxNQUFNLENBQUMsdUJBQXVCLENBQUMsS0FBb0I7UUFDakQsT0FBTywyQkFBWSxDQUFDLGNBQWMsQ0FBbUIsdUJBQVUsQ0FBQyxvQkFBb0IsRUFBRSxLQUFLLENBQUMsQ0FBQztJQUMvRixDQUFDO0lBRUQsTUFBTSxDQUFDLGtCQUFrQixDQUFDLEtBQWlCO1FBQ3pDLElBQUksS0FBSyxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsRUFBRTtZQUN4QixPQUFPLEtBQUssQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7U0FDdEQ7UUFDRCxPQUFPLElBQUksQ0FBQyxlQUFlLENBQUMsS0FBSyxDQUFDLENBQUM7SUFDckMsQ0FBQztJQUVPLE1BQU0sQ0FBQyxlQUFlLENBQUMsSUFBZTtRQUM1QyxRQUFRLE9BQU8sSUFBSSxFQUFFO1lBQ25CLEtBQUssUUFBUTtnQkFDWCxPQUFPLEVBQUUsSUFBSSxFQUFFLElBQUksRUFBRSxDQUFDO1lBQ3hCLEtBQUssUUFBUTtnQkFDWCxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLEVBQUUsR0FBRyxJQUFJLEVBQUUsS0FBSyxFQUFFLElBQUksQ0FBQyxlQUFlLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLElBQWUsQ0FBQztZQUM3RjtnQkFDRSxNQUFNLE1BQU0sR0FBRyxJQUFJLENBQUMsZUFBZSxDQUFDLElBQUksQ0FBQyxDQUFDO2dCQUMxQyxPQUFPLE1BQU0sYUFBTixNQUFNLGNBQU4sTUFBTSxHQUFJLEVBQUUsSUFBSSxFQUFFLFFBQVEsRUFBRSxDQUFDO1NBQ3ZDO0lBQ0gsQ0FBQztDQUNGO0FBM0RELGdDQTJEQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2NoZW1hVXRpbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy91dGlsL3NjaGVtYVV0aWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQ0Esd0VBQXFDO0FBQ3JDLDBEQUFzRTtBQUV0RSx1REFBb0Q7QUFDcEQsdUNBQW9DO0FBR3BDLE1BQWEsVUFBVTtJQUNyQixNQUFNLENBQUMsZUFBZSxDQUFDLEtBQW9CO1FBQ3pDLE9BQU8sMkJBQVksQ0FBQyxjQUFjLENBQVUsdUJBQVUsQ0FBQyxZQUFZLEVBQUUsS0FBSyxDQUFDLENBQUM7SUFDOUUsQ0FBQztJQUVELE1BQU0sQ0FBQyxxQkFBcUIsQ0FBQyxLQUFvQjtRQUMvQyxNQUFNLFdBQVcsR0FBRywyQkFBWSxDQUFDLGNBQWMsQ0FBVSx1QkFBVSxDQUFDLFlBQVksRUFBRSxLQUFLLENBQUMsQ0FBQztRQUN6RixJQUFJLENBQUMsV0FBVyxFQUFFO1lBQ2hCLE1BQU0sV0FBVyxHQUFHLDJCQUFZLENBQUMsV0FBVyxDQUFVLHVCQUFVLENBQUMsWUFBWSxFQUFFLEtBQUssQ0FBQyxDQUFDO1lBQ3RGLE1BQU0sZUFBZSxHQUFHLFdBQVcsQ0FBQyxDQUFDLENBQUMsSUFBQSwwQkFBSyxFQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsVUFBVSxFQUFFLEVBQUUsRUFBRSxRQUFRLEVBQUUsRUFBRSxFQUFFLENBQUM7WUFDNUcsMkJBQVksQ0FBQyxjQUFjLENBQUMsdUJBQVUsQ0FBQyxZQUFZLEVBQUUsZUFBZSxFQUFFLEtBQUssQ0FBQyxDQUFDO1NBQzlFO1FBQ0QsT0FBTywyQkFBWSxDQUFDLGNBQWMsQ0FBVSx1QkFBVSxDQUFDLFlBQVksRUFBRSxLQUFLLENBQUUsQ0FBQztJQUMvRSxDQUFDO0lBRUQsTUFBTSxDQUFDLGVBQWUsQ0FBQyxLQUFvQixFQUFFLFdBQW1COztRQUM5RCxPQUFPLE1BQUEsMkJBQVksQ0FBQyxjQUFjLENBQXVCLHVCQUFVLENBQUMsWUFBWSxFQUFFLEtBQUssQ0FBQywwQ0FBRSxHQUFHLENBQUMsV0FBVyxDQUFDLENBQUM7SUFDN0csQ0FBQztJQUVELE1BQU0sQ0FBQyxxQkFBcUIsQ0FBQyxLQUFvQixFQUFFLFdBQW1CO1FBQ3BFLE1BQU0sU0FBUyxHQUFHLDJCQUFZLENBQUMsa0JBQWtCLENBQWtCLHVCQUFVLENBQUMsWUFBWSxFQUFFLEtBQUssRUFBRSxJQUFJLEdBQUcsRUFBRSxDQUFDLENBQUM7UUFDOUcsT0FBTyxpQkFBTyxDQUFDLFVBQVUsQ0FBQyxTQUFTLEVBQUUsV0FBVyxFQUFFO1lBQ2hELElBQUksRUFBRSxRQUFRO1lBQ2QsVUFBVSxFQUFFLEVBQUU7WUFDZCxRQUFRLEVBQUUsRUFBRTtTQUNiLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFRCxNQUFNLENBQUMscUJBQXFCLENBQUMsS0FBb0IsRUFBRSxXQUFtQjs7UUFDcEUsT0FBTyxNQUFBLDJCQUFZLENBQUMsY0FBYyxDQUFtQyx1QkFBVSxDQUFDLGNBQWMsRUFBRSxLQUFLLENBQUMsMENBQUUsR0FBRyxDQUFDLFdBQVcsQ0FBQyxDQUFDO0lBQzNILENBQUM7SUFFRCxNQUFNLENBQUMsMkJBQTJCLENBQUMsS0FBb0IsRUFBRSxXQUFtQjtRQUMxRSxNQUFNLEdBQUcsR0FBRywyQkFBWSxDQUFDLGtCQUFrQixDQUE4Qix1QkFBVSxDQUFDLGNBQWMsRUFBRSxLQUFLLEVBQUUsSUFBSSxHQUFHLEVBQUUsQ0FBQyxDQUFDO1FBQ3RILE9BQU8saUJBQU8sQ0FBQyxVQUFVLENBQThCLEdBQUcsRUFBRSxXQUFXLEVBQUUsSUFBSSxHQUFHLEVBQUUsQ0FBQyxDQUFDO0lBQ3RGLENBQUM7SUFFRCxNQUFNLENBQUMsdUJBQXVCLENBQUMsS0FBb0I7UUFDakQsT0FBTywyQkFBWSxDQUFDLGNBQWMsQ0FBbUIsdUJBQVUsQ0FBQyxvQkFBb0IsRUFBRSxLQUFLLENBQUMsQ0FBQztJQUMvRixDQUFDO0lBRUQsTUFBTSxDQUFDLGtCQUFrQixDQUFDLEtBQWlCO1FBQ3pDLElBQUksS0FBSyxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsRUFBRTtZQUN4QixPQUFPLEtBQUssQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7U0FDdEQ7UUFDRCxPQUFPLElBQUksQ0FBQyxlQUFlLENBQUMsS0FBSyxDQUFDLENBQUM7SUFDckMsQ0FBQztJQUVPLE1BQU0sQ0FBQyxlQUFlLENBQUMsSUFBZTtRQUM1QyxRQUFRLE9BQU8sSUFBSSxFQUFFO1lBQ25CLEtBQUssUUFBUTtnQkFDWCxPQUFPLEVBQUUsSUFBSSxFQUFFLElBQUksRUFBRSxDQUFDO1lBQ3hCLEtBQUssUUFBUTtnQkFDWCxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLEVBQUUsR0FBRyxJQUFJLEVBQUUsS0FBSyxFQUFFLElBQUksQ0FBQyxlQUFlLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLElBQWUsQ0FBQztZQUM3RixPQUFPLENBQUMsQ0FBQztnQkFDUCxNQUFNLE1BQU0sR0FBRyxJQUFJLENBQUMsZUFBZSxDQUFDLElBQUksQ0FBQyxDQUFDO2dCQUMxQyxPQUFPLE1BQU0sYUFBTixNQUFNLGNBQU4sTUFBTSxHQUFJLEVBQUUsSUFBSSxFQUFFLFFBQVEsRUFBRSxDQUFDO2FBQ3JDO1NBQ0Y7SUFDSCxDQUFDO0NBQ0Y7QUE1REQsZ0NBNERDIn0=

dist/util/typings.d.ts

@@ -1,1 +0,1 @@
-export declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
+export type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;

package.json

 {
   "name": "@marmot/node-validate",
   "description": "validate core package",
-  "version": "1.0.0",
+  "version": "1.0.1-alpha.0",
   "main": "dist/index.js",
@@ -30,3 +30,3 @@ "module": "dist/index.esm.js",
   },
-  "gitHead": "5d33fa11601fbc1886c37016950afbc3dae273a7"
+  "gitHead": "0ffe4cc302b00c81198b8eeb9000389869b9772d"
 }

README.md

 # @marmot/node-validate
-validator for node
+
+基于 [ajv](https://github.com/ajv-validator/ajv) 的装饰器版 node 校验工具。
+
+## 安装
+
+```bash
+npm i --save @marmot/node-validate
+```
+
+## 准备
+
+tsconfig.json 需要开启装饰器特性及元信息。
+
+```json
+// tsconfig.json
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true
+  }
+}
+```
+
+## 使用
+
+### 模型定义
+
+对于复杂的对象参数，使用 class 定义参数对象类型，并使用 Schema 及 Prop 等等装饰器标注每个属性的校验规则。
+
+```typescript
+import {
+  EnumProp,
+  Nullable,
+  NullableProp,
+  Prop,
+  Schema,
+} from '@marmot/node-validate';
+
+export enum FilterType {
+  All = 'ALL',
+  Search = 'SEARCH',
+}
+
+@Schema()
+export class Req {
+  // 必填 number 类型参数
+  @Prop()
+  pageNumber: number;
+
+  // 非必填 number 类型参数
+  @NullableProp()
+  pageSize?: number;
+
+  // 非必填枚举类型参数
+  @Nullable()
+  @EnumProp({ values: Object.values(FilterType) })
+  type?: FilterType;
+
+  // 默认值为 '' 的 string 类型参数
+  @Prop({ default: '' })
+  filter: string;
+
+  // 参数类型比较复杂时，无法自动推导类型，需要手动指定参数类型
+  @Prop({ type: ['string', 'number'] })
+  mixed: string | number;
+}
+```
+
+### 参数校验
+
+对需要做参数校验的函数，使用 Validate 装饰器对该函数进行标注，并通过 Arg 装饰器标注需要进行校验的函数参数。
+
+```typescript
+import { Arg, MaximumArg, Minimumm, Nullable, Validate } from '@marmot/node-validate';
+
+class Runner {
+  @Validate()
+  async run(
+    // 复杂对象参数，Arg 装饰器搭配[模型定义]章节中申明的 Req 类使用
+    @Arg() req: Req,
+    // 基础类型参数，直接使用 Arg 装饰器
+    @Minimum(10) @MaximumArg({ maximum: 100 }) size: number,
+    @Nullable() @Arg() type?: string,
+    // 直接解构等特殊场景，无法自动获取参数名时，可手动指定参数名，便于排查问题
+    @Arg({ name: 'customName' }) { filter }: Req = {},
+    // 参数类型比较复杂时，无法自动推导类型，需要手动指定参数类型
+    @Arg({ type: ['number', 'string'] }) mixed?: string | number,
+    // 未使用 Arg 装饰器标注的参数不会进行校验
+    extra?: boolean,
+  ) {
+    // 函数逻辑
+  ...
+  }
+}
+
+const runner = new Runner();
+try {
+  runner.run({});
+} catch (e) {
+  // 参数校验失败时，抛出异常
+}
+```
+
+## 详细说明
+
+### Prop 装饰器
+
+用于定义复杂对象每个属性的校验规则，与 Schema 装饰器配合使用。
+
+注意：使用 XXXProp 可以看作是同时使用 XXX 装饰器与 Prop 装饰器的 alias。对于需要设置多个条件的函数参数，请务必只使用一次 Prop 装饰器。
+
+```typescript
+// 例如长度小于 10 的非必填函数参数，下列用法 1, 用法 2 以及用法 3 等价，用法 4 和用法 5 是错误的。
+@Schema()
+class DemoSchema {
+  // 用法 1
+  @Nullable()
+  @MaxLength(10)
+  @Prop()
+  param1?: string;
+  // 用法 2
+  @MaxLength(10)
+  @NullableProp()
+  param2?: string;
+  // 用法 3
+  @Nullable()
+  @MaxLengthProp({ maxLength: 10 })
+  param3?: string;
+  // ❌ 用法 4，错误示例
+  @NullableArg()
+  @MaxLengthProp({ maxLength: 10 })
+  param4?: string;
+  // ❌ 用法 5，错误示例
+  @Nullable()
+  @MaxLengthProp({ maxLength: 10 })
+  @Arg()
+  param5?: string;
+}
+```
+
+<table>
+<thead>
+<tr>
+<th>装饰器</th>
+<th>说明</th>
+<th>装饰器参数类型</th>
+<th>示例</th>
+</tr>
+</thead>
+
+<tbody>
+<tr>
+<td>Prop</td>
+<td>标注属性为必填参数</td>
+<td>IPropOptions</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 基础用法
+  @Prop()
+  param1: number;
+  // 其他由 Schema & Prop 标注的 class 类型
+  @Prop()
+  param2: OtherReq;
+  // 指定参数
+  @Prop({
+    default: true,
+    message: 'invalid param3 message',
+  })
+  param3: boolean;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Nullable, NullableProp</td>
+<td>标注属性为非必填参数</td>
+<td>无</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 可空
+  @NullableProp()
+  param1?: number;
+  // 空或 'forever'
+  @Nullable()
+  @ConstProp({ value: 'forever' })
+  param2?: string;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Const, ConstProp</td>
+<td>
+
+标注属性为[常量参数](https://ajv.js.org/json-schema.html#const)
+
+</td>
+<td>any</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且只能为 1
+  @ConstProp({ value: 1 })
+  param1: number;
+  // 只能为 'forever' 或空
+  @Const('forever')
+  @NullableProp()
+  param2: string;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Enum, EnumProp</td>
+<td>
+
+标注属性取值范围[常量列表](https://ajv.js.org/json-schema.html#enum)
+
+</td>
+<td>any[]</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且取值为 1, '1' 或 true
+  @EnumProp({
+    type: ['number', 'string', 'boolean'],
+    values: [1, '1', true],
+  })
+  param1: 1 | '1' | true;
+  // 取值为空，'one' 或 'two'
+  @Enum(['one', 'two'])
+  @NullableProp()
+  param2: string;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Maximum, MaximumProp</td>
+<td>
+
+标注 number 类型属性[最大值（包含最大值）](https://ajv.js.org/json-schema.html#maximum-minimum-and-exclusivemaximum-exclusiveminimum)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且小于等于 100
+  @MaximumProp({ maximum: 100 })
+  param1: number;
+  // 必填且取值在 80 与 90 之间（包含边界值）
+  @Maximum(90)
+  @MinimumProp({ minimum: 80 })
+  param2: number;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Minimum, MinimumProp</td>
+<td>
+
+标注 number 类型属性[最小值（包含最小值）](https://ajv.js.org/json-schema.html#maximum-minimum-and-exclusivemaximum-exclusiveminimum)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且大于等于 100
+  @MinimumProp({ minimum: 100 })
+  param1: number;
+  // 必填且取值在 80 与 90 之间（包含边界值）
+  @Minimum(80)
+  @MaximumProp({ maximum: 90 })
+  param2: number;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>ExclusiveMaximum, ExclusiveMaximumProp</td>
+<td>
+
+标注 number 类型属性[最大值（不包含最大值）](https://ajv.js.org/json-schema.html#maximum-minimum-and-exclusivemaximum-exclusiveminimum)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且小于 100
+  @ExclusiveMaximumProp({
+    exclusiveMaximum: 100,
+  })
+  param1: number;
+  // 必填且取值在 80 与 90 之间（不包含 90）
+  @ExclusiveMaximum(90)
+  @MinimumProp({ minimum: 80 })
+  param2: number;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>ExclusiveMinimum, ExclusiveMinimumProp</td>
+<td>
+
+标注 number 类型属性[最小值（不包含最小值）](https://ajv.js.org/json-schema.html#maximum-minimum-and-exclusivemaximum-exclusiveminimum)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且大于 90
+  @ExclusiveMinimumProp({
+    exclusiveMinimum: 90,
+  })
+  param1: number;
+  // 必填且取值在 80 与 90 之间（不包含 80）
+  @ExclusiveMinimum(80)
+  @MaximumProp({ maximum: 90 })
+  param2: number;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>MultipleOf, MultipleOfProp</td>
+<td>
+
+标注 number 类型属性为某个数的[倍数](https://ajv.js.org/json-schema.html#multipleof)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且为 2 的倍数
+  @MultipleOfProp({ multipleOf: 2 })
+  param1: number;
+  // 必填且取值为 90 以内 3 的倍数
+  @MultipleOf(3)
+  @MaximumProp({ maximum: 90 })
+  param2: number;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>MaxLength, MaxLengthProp</td>
+<td>
+
+标注 string 类型属性的[最大长度](https://ajv.js.org/json-schema.html#maxlength-minlength)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且长度最大为 10
+  @MaxLengthProp({ maxLength: 10 })
+  param1: string;
+  // 必填且长度在 2 到 10 之间
+  @MaxLength(10)
+  @MinLengthProp({ minLength: 2 })
+  param2: string;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>MinLength, MinLengthProp</td>
+<td>
+
+标注 string 类型属性的[最小长度](https://ajv.js.org/json-schema.html#maxlength-minlength)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且长度最小为 10
+  @MinLengthProp({ minLength: 10 })
+  param1: string;
+  // 必填且长度在 2 到 10 之间
+  @MinLength(2)
+  @MaxLengthProp({ maxLength: 10 })
+  param2: string;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Pattern, PatternProp</td>
+<td>
+
+标注 string 类型的[正则规则](https://ajv.js.org/json-schema.html#pattern)
+
+</td>
+<td>string</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且包含数字
+  @PatternProp({ pattern: '\\d+' })
+  param1: string;
+  // 必填且长度在 10 以内的数字字符串
+  @Pattern('^\\d+$')
+  @MaxLengthProp({ maxLength: 10 })
+  param2: string;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Format, FormatProp</td>
+<td>
+
+标注 string 类型的[预设规则](https://ajv.js.org/json-schema.html#format)
+
+</td>
+<td>
+
+参考 [ajv-formats](https://github.com/ajv-validator/ajv-formats#formats)
+
+</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且满足 ipv4 格式
+  @FormatProp({ format: 'ipv4' })
+  param1: string;
+  // 必填且长度在 20 以内的域名
+  @Format('hostname')
+  @MaxLengthProp({ maxLength: 20 })
+  param2: string;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>MaxItems, MaxItemsProp</td>
+<td>
+
+标注数组类型的[最大元素个数](https://ajv.js.org/json-schema.html#maxitems-minitems)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且最多包含 5 个元素
+  @MaxItemsProp({ maxItems: 5 })
+  param1: string[];
+  // 必填且元素个数在 2 到 5 之间
+  @MaxItems(5)
+  @MinItemsProp({ minItems: 2 })
+  param2: number[];
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>MinItems, MinItemsProp</td>
+<td>
+
+标注数组类型的[最小元素个数](https://ajv.js.org/json-schema.html#maxitems-minitems)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且最少包含 5 个元素
+  @MinItemsProp({ minItems: 5 })
+  param1: string[];
+  // 必填且元素个数在 2 到 5 之间
+  @MinItems(2)
+  @MaxItemsProp({ maxItems: 5 })
+  param2: number[];
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>ArrayItem, ArrayItemProp</td>
+<td>
+
+标注数组类型包含元素的校验类型
+
+</td>
+<td>SchemaType, MetadataClass, Array&lt;SchemaType | MetadataClass&gt;</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且数组元素均为字符串
+  @ArrayItemProp({ items: 'string' })
+  param1: string[];
+  // 必填且数组元素均为 OtherSchema 类型
+  @ArrayItemProp({ items: OtherSchema })
+  param2: OtherSchema[];
+  // 非必填且数组元素为 OtherSchema 或字符串类型
+  @ArrayItem(['string', OtherSchema])
+  @NullableProp()
+  param3: Array<string | OtherSchema>;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>ArrayTuple, ArrayTupleProp</td>
+<td>
+
+标注元组类型包含元素的校验类型
+
+</td>
+<td>Array&lt;SchemaType, MetadataClass, Array&lt;SchemaType | MetadataClass&gt;&gt;</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且为 [字符串，数组] 格式二元组
+  @ArrayTupleProp({ items: ['string', 'number'] })
+  param1: string[];
+  // 非必填且为 [数组，字符串，OtherSchema] 格式三元组
+  @ArrayTuple(['number', 'string', OtherSchema])
+  @NullableProp()
+  param2: OtherSchema[];
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Trim, TrimProp</td>
+<td>移除 string 类型属性前后的空白字符</td>
+<td>无</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 基础用法
+  @TrimProp()
+  param1: string;
+  // 移除前后的空白字符后，最大长度为 10
+  @Trim()
+  @MaxLengthProp({ maxLength: 10 })
+  param2: string;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>TrimStart, TrimStartProp</td>
+<td>移除 string 类型属性前面的空白字符</td>
+<td>无</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 基础用法
+  @TrimStartProp()
+  param1: string;
+  // 移除前面的空白字符后，最大长度为 10
+  @TrimStart()
+  @MaxLengthProp({ maxLength: 10 })
+  param2: string;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>TrimEnd, TrimEndProp</td>
+<td>移除 string 类型属性后面的空白字符</td>
+<td>无</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 基础用法
+  @TrimEndProp()
+  param1: string;
+  // 移除后面的空白字符后，最大长度为 10
+  @TrimEnd()
+  @MaxLengthProp({ maxLength: 10 })
+  param2: string;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>ToLowerCase, ToLowerCaseProp</td>
+<td>将 string 类型属性转换为小写字母</td>
+<td>无</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  @ToLowerCaseProp()
+  param1: string;
+
+  @ToLowerCase()
+  @MaxLengthProp({ maxLength: 10 })
+  param2: string;
+}
+```
+
+</td>
+
+<tr>
+<td>ToUpperCase, ToUpperCaseProp</td>
+<td>将 string 类型属性转换为大写字母</td>
+<td>无</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  @ToUpperCaseProp()
+  param1: string;
+
+  @ToUpperCase()
+  @MaxLengthProp({ maxLength: 10 })
+  param2: string;
+}
+```
+
+</td>
+</tr>
+</tbody>
+</table>
+
+### Arg 装饰器
+
+用于标注需要进行参数校验的函数参数，与 Validate 装饰器配合使用。
+
+注意：使用 XXXArg 可以看作是同时使用 XXX 装饰器与 Arg 装饰器的 alias。对于需要设置多个条件的函数参数，请务必只使用一次 Arg 装饰器。
+
+```typescript
+// 例如长度小于 10 的非必填函数参数，下列用法 1, 用法 2 以及用法 3 等价，用法 4 和用法 5 是错误的。
+class Runner {
+  @Validate()
+  async run(
+    // 用法 1
+    @Nullable()
+    @MaxLength(10)
+    @Arg()
+      param1?: string,
+    // 用法 2
+    @MaxLength(10)
+    @NullableArg()
+      param2?: string,
+    // 用法 3
+    @Nullable()
+    @MaxLengthArg({ maxLength: 10 })
+      param3?: string,
+    // ❌ 用法 4，错误示例
+    @NullableArg()
+    @MaxLengthArg({ maxLength: 10 })
+      param4?: string,
+    // ❌ 用法 5，错误示例
+    @Nullable()
+    @MaxLengthArg({ maxLength: 10 })
+    @Arg()
+      param5?: string,
+  ) {...
+  }
+}
+```
+
+<table>
+<thead>
+<tr>
+<th>装饰器</th>
+<th>说明</th>
+<th>装饰器参数类型</th>
+<th>示例</th>
+</tr>
+</thead>
+
+<tbody>
+<tr>
+<td>Arg</td>
+<td>标注函数参数为必填参数</td>
+<td>IArgOptions</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 基础用法
+    @Arg() param1: number,
+    // 其他由 Schema & Prop 标注的 class 类型
+    @Arg() param2: OtherReq,
+    // 指定参数
+    @Arg({
+      name: 'customName',
+      default: true,
+    }) param3: boolean,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Nullable, NullableArg</td>
+<td>标注函数参数为非必填</td>
+<td>无</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 可空
+    @NullableArg() param1?: number,
+    // 空或 'forever'
+    @Nullable()
+    @ConstArg({ value: 'forever' })
+      param2?: string,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Const, ConstArg</td>
+<td>
+
+标注函数参数为[常量参数](https://ajv.js.org/json-schema.html#const)
+
+</td>
+<td>any</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 必填且只能为 1
+    @ConstArg({ value: 1 })
+      param1: number,
+    // 只能为 'forever' 或空
+    @Const('forever')
+    @NullableArg()
+      param2?: string,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Enum, EnumArg</td>
+<td>
+
+标注函数参数取值范围[常量列表](https://ajv.js.org/json-schema.html#enum)
+
+</td>
+<td>any[]</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 必填且取值为 1, '1' 或 true
+    @EnumArg({
+      type: ['number', 'string', 'boolean'],
+      values: [1, '1', true],
+    })
+      param1: 1 | '1' | true,
+    // 取值为空，'one' 或 'two'
+    @Enum(['one', 'two'])
+    @NullableArg()
+      param2?: string,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Maximum, MaximumArg</td>
+<td>
+
+标注 number 类型函数参数[最大值（包含最大值）](https://ajv.js.org/json-schema.html#maximum-minimum-and-exclusivemaximum-exclusiveminimum)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 必填且小于等于 100
+    @MaximumArg({ maximum: 100 })
+      param1: number,
+    // 必填且取值在 80 与 90 之间（包含边界值）
+    @Maximum(90)
+    @MinimumArg({ minimum: 80 })
+      param2: number,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Minimum, MinimumArg</td>
+<td>
+
+标注 number 类型函数参数[最小值（包含最小值）](https://ajv.js.org/json-schema.html#maximum-minimum-and-exclusivemaximum-exclusiveminimum)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 必填且大于等于 100
+    @MinimumArg({ minimum: 100 })
+      param1: number,
+    // 必填且取值在 80 与 90 之间（包含边界值）
+    @Minimum(80)
+    @MaximumArg({ maximum: 90 })
+      param2: number,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>ExclusiveMaximum, ExclusiveMaximumArg</td>
+<td>
+
+标注 number 类型函数参数[最大值（不包含最大值）](https://ajv.js.org/json-schema.html#maximum-minimum-and-exclusivemaximum-exclusiveminimum)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 必填且小于 100
+    @ExclusiveMaximumArg({
+      exclusiveMaximum: 100,
+    })
+      param1: number,
+    // 必填且取值在 80 与 90 之间（不包含 90）
+    @ExclusiveMaximum(90)
+    @MinimumArg({ minimum: 80 })
+      param2: number,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>ExclusiveMinimum, ExclusiveMinimumArg</td>
+<td>
+
+标注 number 类型函数参数[最小值（不包含最小值）](https://ajv.js.org/json-schema.html#maximum-minimum-and-exclusivemaximum-exclusiveminimum)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+@Schema()
+class Req {
+  // 必填且大于 90
+  @ExclusiveMinimumArg({
+    exclusiveMinimum: 90,
+  })
+  param1: number;
+  // 必填且取值在 80 与 90 之间（不包含 80）
+  @ExclusiveMinimum(80)
+  @MaximumArg({ maximum: 90 })
+  param2: number;
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>MultipleOf, MultipleOfArg</td>
+<td>
+
+标注 number 类型函数参数为某个数的[倍数](https://ajv.js.org/json-schema.html#multipleof)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 必填且为 2 的倍数
+    @MultipleOfArg({ multipleOf: 2 })
+      param1: number,
+    // 必填且取值为 90 以内 3 的倍数
+    @MultipleOf(3)
+    @MaximumArg({ maximum: 90 })
+      param2: number,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>MaxLength, MaxLengthArg</td>
+<td>
+
+标注 string 类型函数参数的[最大长度](https://ajv.js.org/json-schema.html#maxlength-minlength)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 必填且长度最大为 10
+    @MaxLengthArg({ maxLength: 10 })
+      param1: string,
+    // 必填且长度在 2 到 10 之间
+    @MaxLength(10)
+    @MinLengthArg({ minLength: 2 })
+      param2: string,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>MinLength, MinLengthArg</td>
+<td>
+
+标注 string 类型函数参数的[最小长度](https://ajv.js.org/json-schema.html#maxlength-minlength)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 必填且长度最小为 10
+    @MinLengthArg({ minLength: 10 })
+      param1: string,
+    // 必填且长度在 2 到 10 之间
+    @MinLength(2)
+    @MaxLengthArg({ maxLength: 10 })
+      param2: string,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Pattern, PatternArg</td>
+<td>
+
+标注 string 类型函数参数的[正则规则](https://ajv.js.org/json-schema.html#pattern)
+
+</td>
+<td>string</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 必填且包含数字
+    @PatternArg({ pattern: '\\d+' })
+      param1: string,
+    // 必填且长度在 10 以内的数字字符串
+    @Pattern('^\\d+$')
+    @MaxLengthArg({ maxLength: 10 })
+      param2: string,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Format, FormatArg</td>
+<td>
+
+标注 string 类型函数参数的[预设规则](https://ajv.js.org/json-schema.html#format)
+
+</td>
+<td>
+
+参考 [ajv-formats](https://github.com/ajv-validator/ajv-formats#formats)
+
+</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 必填且满足 ipv4 格式
+    @FormatArg({ format: 'ipv4' })
+      param1: string,
+    // 必填且长度在 20 以内的域名
+    @Format('hostname')
+    @MaxLengthArg({ maxLength: 20 })
+      param2: string,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>MaxItems, MaxItemsArg</td>
+<td>
+
+标注数组类型函数参数的[最大元素个数](https://ajv.js.org/json-schema.html#maxitems-minitems)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 必填且最多包含 5 个元素
+    @MaxItemsArg({ maxItems: 5 })
+      param1: string[],
+    // 必填且元素个数在 2 到 5 之间
+    @MaxItems(5)
+    @MinItemsArg({ minItems: 2 })
+      param2: number[],
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>MinItems, MinItemsArg</td>
+<td>
+
+标注数组类型函数参数的[最小元素个数](https://ajv.js.org/json-schema.html#maxitems-minitems)
+
+</td>
+<td>number</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 必填且最少包含 5 个元素
+    @MinItemsArg({ minItems: 5 })
+      param1: string[],
+    // 必填且元素个数在 2 到 5 之间
+    @MinItems(2)
+    @MaxItemsArg({ maxItems: 5 })
+      param2: number[],
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>ArrayItem, ArrayItemArg</td>
+<td>
+
+标注数组类型函数参数包含元素的校验类型
+
+</td>
+<td>SchemaType, MetadataClass, Array&lt;SchemaType | MetadataClass&gt;</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 必填且数组元素均为字符串
+    @ArrayItemArg({ items: 'string' })
+      param1: string[],
+    // 必填且数组元素均为 OtherSchema 类型
+    @ArrayItemArg({ items: OtherSchema })
+      param2: OtherSchema[],
+    // 非必填且数组元素为 OtherSchema 或字符串类型
+    @ArrayItem(['string', OtherSchema])
+    @NullableArg()
+      param3: Array<string | OtherSchema>,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>ArrayTuple, ArrayTupleArg</td>
+<td>
+
+标注元组类型函数参数包含元素的校验类型
+
+</td>
+<td>Array&lt;SchemaType, MetadataClass, Array&lt;SchemaType | MetadataClass&gt;&gt;</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 必填且为 [字符串，数组] 格式二元组
+    @ArrayTupleArg({ items: ['string', 'number'] })
+      param1: string[],
+    // 非必填且为 [数组，字符串，OtherSchema] 格式三元组
+    @ArrayTuple(['number', 'string', OtherSchema])
+    @NullableArg()
+      param2: OtherSchema[],
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>Trim, TrimArg</td>
+<td>移除 string 类型函数参数前后的空白字符</td>
+<td>无</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 基础用法
+    @TrimArg()
+      param1: string,
+    // 移除前后的空白字符后，最大长度为 10
+    @Trim()
+    @MaxLengthArg({ maxLength: 10 })
+      param2: string,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>TrimStart, TrimStartArg</td>
+<td>移除 string 类型函数参数前面的空白字符</td>
+<td>无</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 基础用法
+    @TrimStartArg()
+      param1: string,
+    // 移除前面的空白字符后，最大长度为 10
+    @TrimStart()
+    @MaxLengthArg({ maxLength: 10 })
+      param2: string,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>TrimEnd, TrimEndArg</td>
+<td>移除 string 类型函数参数后面的空白字符</td>
+<td>无</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    // 基础用法
+    @TrimEndArg()
+      param1: string,
+    // 移除后面的空白字符后，最大长度为 10
+    @TrimEnd()
+    @MaxLengthArg({ maxLength: 10 })
+      param2: string,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td>ToLowerCase, ToLowerCaseArg</td>
+<td>将 string 类型函数参数转换为小写字母</td>
+<td>无</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    @ToLowerCaseArg()
+      param1: string,
+
+    @ToLowerCase()
+    @MaxLengthArg({ maxLength: 10 })
+      param2: string,
+  ) {...}
+}
+```
+
+</td>
+
+<tr>
+<td>ToUpperCase, ToUpperCaseArg</td>
+<td>将 string 类型函数参数转换为大写字母</td>
+<td>无</td>
+<td>
+
+```typescript
+class Runner {
+  @Validate()
+  async run(
+    @ToUpperCaseArg()
+      param1: string,
+
+    @ToUpperCase()
+    @MaxLengthArg({ maxLength: 10 })
+      param2: string,
+  ) {...}
+}
+```
+
+</td>
+</tr>
+</tbody>
+</table>
+
+### Validate 装饰器
+
+标注需要进行参数校验的函数，与 Arg 装饰器配合使用。
+
+#### 参数说明
+
+```typescript
+export interface IValidateOptions {
+  // 当校验失败时，自定义错误处理逻辑，默认逻辑为直接抛出异常
+  onError?: (error: IValidateError[]) => void;
+}
+```
+
+### 类型说明
+
+#### SchemaType
+```typescript
+export type SchemaType = 'number' | 'integer' | 'string' | 'boolean' | 'array' | 'object' | 'null' | string;
+```
+
+### MetadataClass
+
+由 Schema & Prop 装饰器标注的模型 class
+
+#### IPropOptions
+
+```typescript
+interface IPropOptions {
+  // 参数类型，基础类型可从定义中自动推导，特殊场景可手动指定类型
+  type?: SchemaType | SchemaType[] | MetadataClass;
+  // 参数默认值
+  default?: any;
+  // 指定校验失败时的错误信息
+  message?: string;
+}
+```
+
+#### IArgOptions
+
+```typescript
+interface IArgOptions {
+  // 参数名，直接解构等特殊场景，无法自动获取参数名时，可手动指定参数名，便于排查问题
+  name?: string;
+  // 参数类型，基础类型可从定义中自动推导，特殊场景可手动指定类型
+  type?: SchemaType | SchemaType[] | MetadataClass;
+  // 参数默认值
+  default?: any;
+}
+```
+
+#### IValidateError
+
+```typescript
+interface IValidateError {
+  // 校验失败字段
+  field: string;
+  // 校验失败原因
+  message?: string;
+}
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

123567

increased by25.67%

Lines of code

1099

increased by0.27%

Number of lines in readme file

1424

increased by47366.67%

Worsened metrics

Number of low quality alerts

2

increased by100%

No dependency changes