Class NestKitValidationPipe

Hierarchy

ValidationPipe
- NestKitValidationPipe

Constructors

constructor

new NestKitValidationPipe(
options?: ValidationPipeOptions,
): NestKitValidationPipe
Parameters
- Optionaloptions: ValidationPipeOptions
Returns NestKitValidationPipe
Inherited from ValidationPipe.constructor
- Defined in node_modules/@nestjs/common/pipes/validation.pipe.d.ts:37

Properties

`Protected`errorHttpStatusCode

errorHttpStatusCode: ErrorHttpStatusCode

`Protected`exceptionFactory

exceptionFactory: (errors: ValidationError[]) => any

`Protected`expectedType

expectedType: undefined | Type<any>

`Protected` `Optional`isDetailedOutputDisabled

isDetailedOutputDisabled?: boolean

`Protected`isTransformEnabled

isTransformEnabled: boolean

`Protected`transformOptions

transformOptions: undefined | ClassTransformOptions

`Protected`validateCustomDecorators

validateCustomDecorators: boolean

`Protected`validatorOptions

validatorOptions: ValidatorOptions

Methods

createExceptionFactory

createExceptionFactory(): (
validationErrors?: ValidationError[],
) => BadRequestException
Returns (validationErrors?: ValidationError[]) => BadRequestException
Overrides ValidationPipe.createExceptionFactory
- Defined in libs/core/src/validation/validation-pipe.ts:6

`Protected`flattenValidationErrors

flattenValidationErrors(validationErrors: ValidationError[]): string[]
Parameters
- validationErrors: ValidationError[]
Returns string[]
Inherited from ValidationPipe.flattenValidationErrors
- Defined in node_modules/@nestjs/common/pipes/validation.pipe.d.ts:48

`Protected`isPrimitive

isPrimitive(value: unknown): boolean
Parameters
- value: unknown
Returns boolean
Inherited from ValidationPipe.isPrimitive
- Defined in node_modules/@nestjs/common/pipes/validation.pipe.d.ts:46

`Protected`loadTransformer

loadTransformer(transformerPackage?: TransformerPackage): TransformerPackage
Parameters
- OptionaltransformerPackage: TransformerPackage
Returns TransformerPackage
Inherited from ValidationPipe.loadTransformer
- Defined in node_modules/@nestjs/common/pipes/validation.pipe.d.ts:39

`Protected`loadValidator

loadValidator(validatorPackage?: ValidatorPackage): ValidatorPackage
Parameters
- OptionalvalidatorPackage: ValidatorPackage
Returns ValidatorPackage
Inherited from ValidationPipe.loadValidator
- Defined in node_modules/@nestjs/common/pipes/validation.pipe.d.ts:38

`Protected`mapChildrenToValidationErrors

mapChildrenToValidationErrors(
error: ValidationError,
parentPath?: string,
): ValidationError[]
Parameters
- error: ValidationError
- OptionalparentPath: string
Returns ValidationError[]
Inherited from ValidationPipe.mapChildrenToValidationErrors
- Defined in node_modules/@nestjs/common/pipes/validation.pipe.d.ts:49

`Protected`prependConstraintsWithParentProp

prependConstraintsWithParentProp(
parentPath: string,
error: ValidationError,
): ValidationError
Parameters
- parentPath: string
- error: ValidationError
Returns ValidationError
Inherited from ValidationPipe.prependConstraintsWithParentProp
- Defined in node_modules/@nestjs/common/pipes/validation.pipe.d.ts:50

`Protected`stripProtoKeys

stripProtoKeys(value: any): void
Parameters
- value: any
Returns void
Inherited from ValidationPipe.stripProtoKeys
- Defined in node_modules/@nestjs/common/pipes/validation.pipe.d.ts:45

`Protected`toEmptyIfNil

toEmptyIfNil<T = any, R = T>(
value: T,
metatype: object | Type<unknown>,
): string | object | R
Type Parameters
- T = any
- R = T
Parameters
- value: T
- metatype: object | Type<unknown>
Returns string | object | R
Inherited from ValidationPipe.toEmptyIfNil
- Defined in node_modules/@nestjs/common/pipes/validation.pipe.d.ts:44

`Protected`toValidate

toValidate(metadata: ArgumentMetadata): boolean
Parameters
- metadata: ArgumentMetadata
Returns boolean
Inherited from ValidationPipe.toValidate
- Defined in node_modules/@nestjs/common/pipes/validation.pipe.d.ts:42

transform

transform(value: any, metadata: ArgumentMetadata): Promise<any>
Method to implement a custom pipe. Called with two parameters
Parameters
- value: any
  argument before it is received by route handler method
- metadata: ArgumentMetadata
  contains metadata about the value
Returns Promise<any>
Inherited from ValidationPipe.transform
- Defined in node_modules/@nestjs/common/pipes/validation.pipe.d.ts:40

`Protected`transformPrimitive

transformPrimitive(value: any, metadata: ArgumentMetadata): any
Parameters
- value: any
- metadata: ArgumentMetadata
Returns any
Inherited from ValidationPipe.transformPrimitive
- Defined in node_modules/@nestjs/common/pipes/validation.pipe.d.ts:43

`Protected`validate

validate(
object: object,
validatorOptions?: ValidatorOptions,
): ValidationError[] | Promise<ValidationError[]>
Parameters
- object: object
- OptionalvalidatorOptions: ValidatorOptions
Returns ValidationError[] | Promise<ValidationError[]>
Inherited from ValidationPipe.validate
- Defined in node_modules/@nestjs/common/pipes/validation.pipe.d.ts:47

Class NestKitValidationPipe

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NestKitValidationPipe

Properties

ProtectederrorHttpStatusCode

ProtectedexceptionFactory

ProtectedexpectedType

Protected OptionalisDetailedOutputDisabled

ProtectedisTransformEnabled

ProtectedtransformOptions

ProtectedvalidateCustomDecorators

ProtectedvalidatorOptions

Methods

createExceptionFactory

Returns (validationErrors?: ValidationError[]) => BadRequestException

ProtectedflattenValidationErrors

Parameters

Returns string[]

ProtectedisPrimitive

Parameters

Returns boolean

ProtectedloadTransformer

Parameters

Returns TransformerPackage

ProtectedloadValidator

Parameters

Returns ValidatorPackage

ProtectedmapChildrenToValidationErrors

Parameters

Returns ValidationError[]

ProtectedprependConstraintsWithParentProp

Parameters

Returns ValidationError

ProtectedstripProtoKeys

Parameters

Returns void

ProtectedtoEmptyIfNil

Type Parameters

Parameters

Returns string | object | R

ProtectedtoValidate

Parameters

Returns boolean

transform

Parameters

Returns Promise<any>

ProtectedtransformPrimitive

Parameters

Returns any

Protectedvalidate

Parameters

Returns ValidationError[] | Promise<ValidationError[]>

Settings

On This Page

`Protected`errorHttpStatusCode

`Protected`exceptionFactory

`Protected`expectedType

`Protected` `Optional`isDetailedOutputDisabled

`Protected`isTransformEnabled

`Protected`transformOptions

`Protected`validateCustomDecorators

`Protected`validatorOptions

`Protected`flattenValidationErrors

`Protected`isPrimitive

`Protected`loadTransformer

`Protected`loadValidator

`Protected`mapChildrenToValidationErrors

`Protected`prependConstraintsWithParentProp

`Protected`stripProtoKeys

`Protected`toEmptyIfNil

`Protected`toValidate

`Protected`transformPrimitive

`Protected`validate