Batch Validation: validate multi objects

FEATURES

to validate multiple objects, the library provides batchValidate() and batchValidatethrow() methods of Validator, this method accept list of objects, of the same type, to be validated.

Method	Args	Description
`batchValidate()`	Array of Object	return `BatchValidatorResultInfo`
`batchValidatethrow()`	Array of Object	throw `BshBatchValidationError` in case of invalid data


validator.batchValidate(object1, object2, object3);
validator.batchValidateThrow(object1, object2, object3);

API

`BatchValidatorResultInfo`


type BatchValidatorResultInfo = {
    success: boolean, // true if all object are valid
    results: {
        success: boolean, // true if the object is valid
        results?: ValidatorResult // will contain error messages of invalid property
    }[]
}

`BshBatchValidationError`


class BshBatchValidationError extends BshgError {
    readonly results: {
        success: boolean, // true if the object is valid
        results?: ValidatorResult // will contain error messages of invalid property
    }[] // the same object returned by `BatchValidatorResultInfo()`
}

EXAMPLE

in this example we will play around this validator


type User = {
    username: string
    email: string
}
const userValidator = v.validator<User>({
    id: "userValidator",
    items: {
        email: v.string().required().email(),
        username: v.string().required().notEmpty(),
    }
});

`batchValidate()`


const batchValidate = userValidator.batchValidate(
    {email: 'email@mail.com', username: 'bshg'},
    {email: 'email.com', username: 'bshg'},
    {email: 'email@mail.com', username: ''},
    {email: '', username: ''}
);

will return this object:


{
  "success": false,
  "results": [
    { "success": true }, // first object is valid
    {
      "success": false,
      "results": {
         "items": [
           {"field": "email", "message": "Invalid email format", "valid": false, "value": "email.com" }
         ]
      }
    },
    {
      "success": false,
      "results": {
        "items": [
          { "field": "username", "message": "This field is required!", "valid": false, "value": ""}
        ]
      }
    },
    {
      "success": false,
      "results": {
        "items": [
          {"field": "email", "message": "Invalid email format", "valid": false, "value": "" },
          {"field": "username", "message": "This field is required!", "valid": false, "value": ""}
        ]
      }
    }
  ]
}