Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IValidationRule

Interface for validation rules.

Validation rule can validate one or multiple values against complex rules like: value is in range, one property is less than another property, enforce enumerated values and more.

This interface allows to implement custom rules.

Hierarchy

  • IValidationRule

Implemented by

Index

Methods

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