Class ValidatedVariable<V, T, C>

Similar to Variable, except the variable's value can optionally be validated by a validator function.

Type Parameters

V

The type of value.
T = V

The transformed type of a valid value.
C extends CallableFunction = ValidatedVariableCallback<V, T>

Hierarchy

Variable<V, C>
- ValidatedVariable

Index

Constructors

Properties

_valid _validValue? validator

Accessors

valid validValue value

Methods

doCallback hasCallback setValue unwatch validate watch

Constructors

constructor

new ValidatedVariable<V, T, C>(initialValue: V, validator?: null | Validator<V, T>, callback?: C, callNow?: boolean): ValidatedVariable<V, T, C>
Type Parameters
- V
- T = V
- C extends CallableFunction = ValidatedVariableCallback<V, T>
Parameters
- initialValue: V
- validator: null | Validator<V, T> = null
- Optional callback: C
- callNow: boolean = true
Returns ValidatedVariable<V, T, C>
Overrides Variable.constructor
- Defined in src/state/ValidatedVariable.ts:45

Properties

`Private` _valid

_valid: boolean = true

See valid. For internal use only

`Private` `Optional` _validValue

_validValue?: T

See validValue. For internal use only

`Readonly` validator

validator: null | Validator<V, T>

The validator/transformer used for this variable's value. If null, then the value will always be valid and validValue will be equal to value.

Accessors

valid

get valid(): boolean
If true, then the current value is valid.

Returns boolean
- Defined in src/state/ValidatedVariable.ts:56

validValue

get validValue(): T
The last valid value. If there was never a valid value, undefined is returned.

Returns T
- Defined in src/state/ValidatedVariable.ts:64

value

get value(): V
The current value.

If setting, setValue is called.

Returns V
Inherited from Variable.value
- Defined in src/state/Variable.ts:45
set value(value: V): void
Parameters
- value: V
Returns void
Inherited from Variable.value
- Defined in src/state/Variable.ts:49

Methods

`Protected` doCallback

doCallback(callback: C): void
Parameters
- callback: C
Returns void
Inherited from Variable.doCallback
- Defined in src/state/Variable.ts:102

hasCallback

hasCallback(callback: C): boolean
Check if a callback is registered to this variable.
Parameters
- callback: C
Returns boolean
Inherited from Variable.hasCallback
- Defined in src/state/Variable.ts:54

setValue

setValue(value: V, notify?: boolean): boolean
Sets _value. Does nothing if the value is already the one specified.

Returns
Returns true if the value was changed, false if not
Parameters
- value: V
- notify: boolean = true
  
  If true, then the callbacks are called.
Returns boolean
Overrides Variable.setValue
- Defined in src/state/ValidatedVariable.ts:68

unwatch

unwatch(callback: C): boolean
Unregister a previously registered callback from this variable.
Parameters
- callback: C
Returns boolean
Inherited from Variable.unwatch
- Defined in src/state/Variable.ts:77

`Private` validate

validate(value: V): void
Parameters
- value: V
Returns void
- Defined in src/state/ValidatedVariable.ts:77

watch

watch(callback: C, callNow?: boolean): boolean
Register a callback to this variable. When the value is changed, the callback will be called.
Parameters
- callback: C
- callNow: boolean = true
  
  If true, the callback will be called once immediately after it's registered, unless the callback is already registered.
Returns boolean
Inherited from Variable.watch
- Defined in src/state/Variable.ts:64

Generated using TypeDoc