OrRule

Validation rule that allows you to check combinations of rules created with OR logical operations.

Implements: IValidationRule

Description

The OrRule class allows you to validate combinations of rules created with OR logical operations.

Important points

  • When one of the combined rules returns no errors, then this rule also returns no errors.
  • When all combined rules return errors, then this rule returns all the errors.

Constructors

Creates a new validation rule and sets its values.

public constructor(…rules: IValidationRule[])

Instance methods

validate

Validates a given value against this rule.

public validate(path: string, schema: Schema, value: any, results: ValidationResult[]): void

  • path: string - a dot notation path to the value.
  • schema: Schema - a schema this rule is called from
  • value: any - a value to be validated.
  • results: ValidationResult[] - a list with validation results to add new results.

Examples

let schema = new Schema()
    .withRule(new OrRule(
        new ValueComparisonRule("LT", 1),
        new ValueComparisonRule("GT", 10)
    ));
    
schema.validate(0);          // Result: no error
schema.validate(5);          // Result: 5 must be less than 1 or 5 must be more than 10
schema.validate(20);         // Result: no error

See also