Interface ValidationState

Packages key values of the state of validation to be returned by validate() and in the onValidationStateChanged callback. The same values are also available directly on ValidationManager.

interface ValidationState {
    isValid: boolean;
    doNotSave: boolean;
    issuesFound: null | IssueFound[];
    asyncProcessing: boolean;
}

Hierarchy (view full)

Properties

isValid: boolean

When true, there is nothing known to block validation. However, there are other factors to consider: there may be warning issues found or an async validator is still running. So check doNotSaveValueHosts as the ultimate guide to saving. When false, there is at least one validation error.

doNotSave: boolean

Determines if a validator doesn't consider the ValueHost's value ready to save based on the latest call to validate(). (It does not run validate().) True when ValidationStatus is Invalid or NeedsValidation on individual validators.

issuesFound: null | IssueFound[]

All issues current found (except ValueHosts not matching the validation group which are excluded.) Includes issues found by setBusinessLogicErrors too. If none, it is null

asyncProcessing: boolean

When true, an async Validator is running

Generated using TypeDoc v0.25.12