Class ValidationState<TValue>

represents state for a value which is validated

useful for user facing components

Type parameters

TValue

Hierarchy

ValidationState

Implements

IValidationState<TValue>

Index

Constructors

constructor

Properties

Methods

set

Constructors

constructor

new ValidationState<TValue>(validate: IValidate<TValue> | IValidateAsync<TValue>, value?: TValue, errors?: ValidationErrors<TValue>): ValidationState<TValue>

- Defined in state/ValidationState.ts:15
Type parameters
- TValue
Parameters
- validate: IValidate<TValue> | IValidateAsync<TValue>
- value: TValue = null
- errors: ValidationErrors<TValue> = StandardErrors.EMPTY
Returns ValidationState<TValue>

Properties

Readonly errors

errors: ValidationErrors<TValue>

validation errors

Readonly invalid

invalid: boolean = false

state is invalid

Readonly validate

validate: IValidate<TValue> | IValidateAsync<TValue>

Readonly value

value: TValue = null

Methods

set

set(value: TValue, onChange?: (newState: ValidationState<TValue>) => void): Promise<ValidationState<TValue>>

- Defined in state/ValidationState.ts:40
if there are changes calls validation and sets errors and invalid properites

Parameters
- value: TValue
  
  value to validate if changed
- Optional onChange: (newState: ValidationState<TValue>) => void
  
  a function called when change is made
  - - (newState: ValidationState<TValue>): void
    - Parameters
      - newState: ValidationState<TValue>
      Returns void
Returns Promise<ValidationState<TValue>>
a new state object if there is change, same if not

Generated using TypeDoc