UNPKG

2.7 kBTypeScriptView Raw
1import { ClassTransformOptions } from '../interfaces/external/class-transform-options.interface';
2import { TransformerPackage } from '../interfaces/external/transformer-package.interface';
3import { ValidationError } from '../interfaces/external/validation-error.interface';
4import { ValidatorOptions } from '../interfaces/external/validator-options.interface';
5import { ValidatorPackage } from '../interfaces/external/validator-package.interface';
6import { ArgumentMetadata, PipeTransform } from '../interfaces/features/pipe-transform.interface';
7import { Type } from '../interfaces/type.interface';
8import { ErrorHttpStatusCode } from '../utils/http-error-by-code.util';
9export interface ValidationPipeOptions extends ValidatorOptions {
10 transform?: boolean;
11 disableErrorMessages?: boolean;
12 transformOptions?: ClassTransformOptions;
13 errorHttpStatusCode?: ErrorHttpStatusCode;
14 exceptionFactory?: (errors: ValidationError[]) => any;
15 validateCustomDecorators?: boolean;
16 expectedType?: Type<any>;
17 validatorPackage?: ValidatorPackage;
18 transformerPackage?: TransformerPackage;
19}
20export declare class ValidationPipe implements PipeTransform<any> {
21 protected isTransformEnabled: boolean;
22 protected isDetailedOutputDisabled?: boolean;
23 protected validatorOptions: ValidatorOptions;
24 protected transformOptions: ClassTransformOptions;
25 protected errorHttpStatusCode: ErrorHttpStatusCode;
26 protected expectedType: Type<any>;
27 protected exceptionFactory: (errors: ValidationError[]) => any;
28 protected validateCustomDecorators: boolean;
29 constructor(options?: ValidationPipeOptions);
30 protected loadValidator(validatorPackage?: ValidatorPackage): ValidatorPackage;
31 protected loadTransformer(transformerPackage?: TransformerPackage): TransformerPackage;
32 transform(value: any, metadata: ArgumentMetadata): Promise<any>;
33 createExceptionFactory(): (validationErrors?: ValidationError[]) => unknown;
34 protected toValidate(metadata: ArgumentMetadata): boolean;
35 protected transformPrimitive(value: any, metadata: ArgumentMetadata): any;
36 protected toEmptyIfNil<T = any, R = any>(value: T): R | {};
37 protected stripProtoKeys(value: any): void;
38 protected isPrimitive(value: unknown): boolean;
39 protected validate(object: object, validatorOptions?: ValidatorOptions): Promise<ValidationError[]> | ValidationError[];
40 protected flattenValidationErrors(validationErrors: ValidationError[]): string[];
41 protected mapChildrenToValidationErrors(error: ValidationError, parentPath?: string): ValidationError[];
42 protected prependConstraintsWithParentProp(parentPath: string, error: ValidationError): ValidationError;
43}