Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrRule

Validation rule to combine rules with OR logical operation. When one of rules returns no errors, than this rule also returns no errors. When all rules return errors, than the rule returns all errors.

see

IValidationRule

Example

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

Hierarchy

  • OrRule

Implements

Index

Constructors

Methods

Constructors

constructor

  • Creates a new validation rule and sets its values.

    Parameters

    • Rest ...rules: IValidationRule[]

      a list of rules to join with OR operator

    Returns OrRule

Methods

validate

  • Validates a given value against this rule.

    Parameters

    • 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.

    Returns void

Generated using TypeDoc