Class ValidatorFactory

Validator factory exposes the API to execute validations during tests

Index

Constructors

Methods

withContext withDataTypeValidator bail execute executeAsync

Constructors

constructor

new ValidatorFactory(
    field?: Partial<FieldContext>,
    bail?: boolean,
    dataTypeValidation?: Validation<any>,
): ValidatorFactory
Parameters
- Optionalfield: Partial<FieldContext>
- Optionalbail: boolean
- OptionaldataTypeValidation: Validation<any>
Returns ValidatorFactory
- Defined in factories/validator.ts:135

Methods

withContext

withContext(field: Partial<FieldContext>): ValidatorFactory
Define field context for the validation
Parameters
- field: Partial<FieldContext>
Returns ValidatorFactory
- Defined in factories/validator.ts:152

withDataTypeValidator

withDataTypeValidator(validation: Validation<any>): ValidatorFactory
Specify a rule for literal data type validation
Parameters
- validation: Validation<any>
Returns ValidatorFactory
- Defined in factories/validator.ts:159

bail

bail(state: boolean): ValidatorFactory
Toggle bail mode for the validation
Parameters
- state: boolean
Returns ValidatorFactory
- Defined in factories/validator.ts:166

execute

execute(
validation: Validation<any> | Validation<any>[],
value: any,
): ValidationResult
Executes a validation against the provided value
Parameters
- validation: Validation<any> | Validation<any>[]
- value: any
Returns ValidationResult
- Defined in factories/validator.ts:173

executeAsync

executeAsync(
validation: Validation<any> | Validation<any>[],
value: any,
): Promise<ValidationResult>
Executes an async validation against the provided value
Parameters
- validation: Validation<any> | Validation<any>[]
- value: any
Returns Promise<ValidationResult>
- Defined in factories/validator.ts:211