UNPKG

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