Optional onCalled when the InputValueHost's InputValue property has changed. If setup, you can prevent it from being fired with the options parameter of setValue() to avoid round trips where you already know the details. You can setup the same callback on individual InputValueHosts. Here, it aggregates all InputValueHost notifications.
Optional onCalled when any ValueHost had its ValueHostInstanceState changed. React example: React component useState feature retains this value and needs to know when to call the setValueHostInstanceState() with the stateToRetain. You can setup the same callback on individual ValueHosts. Here, it aggregates all ValueHost notifications.
Optional onCalled when the ValueHost's Value property has changed. If setup, you can prevent it from being fired with the options parameter of setValue() to avoid round trips where you already know the details. You can setup the same callback on individual ValueHosts. Here, it aggregates all ValueHost notifications.
Provides services into the system. Dependency Injection and factories.
While most objects have a WeakRef to services, we keep an active reference here because we invite the user to create the service, pass it into this Config and let the ValueHostsManager/ValidationManager's reference be the one to access. If this is set to another object created within the scope of ValueHostsManager, that other object should keep a WeakRef to it.
Initial list of ValueHostConfigs. Here's where all of the action is! Each ValueHostConfig describes one ValueHost (which is info about one value in your app), plus its validation rules. If rules need to be changed later, either create a new instance of ValueHostsManager or use its addValueHost, addOrUpdateValueHost, discardValueHost methods.
Optional savedThe InstanceState for the ValueHostsManager itself. Its up to you to retain stateful information so that the service works statelessly. It will supply you with the changes to states through the OnInstanceStateChanged property. Whatever it gives you, you supply here to rehydrate the ValueHostsManager with the correct state. If you don't have any state, leave this null or undefined and ValueHostsManager will initialize its state.
Optional savedThe state for each ValueHost. The array may not have the same states for all the ValueHostConfigs you are supplying. It will create defaults for those missing and discard those no longer in use.
Its up to you to retain stateful information so that the service works statelessly. It will supply you with the changes to states through the OnValueHostInstanceStateChanged property. Whatever it gives you, you supply here to rehydrate the ValueHostsManager with the correct state. You can also supply the state of an individual ValueHost when using the addValueHost or addOrUpdateValueHost methods. If you don't have any state, leave this null or undefined and ValueHostsManager will initialize its state.
Optional onCalled when the ValueHostsManager's InstanceState has changed. React example: React component useState feature retains this value and needs to know when to call the setState function with the stateToRetain
Optional onUse this when caching the configuration for a later creation of ValueHostsManager.
Called when the configuration of ValueHosts has been changed, usually through the ValueHostsManagerConfigModifier.apply, or these members of ValueHostsManager: addValueHost, addOrUpdateValueHost, addOrMergeValueHost, discardValueHost. The supplied object is a clone so modifications will not impact the ValueHostsManager.
Note that where a ValueHostConfig has a property that references a function, you will have to retain that reference in some way to reuse it. In particular, ValidatorConfig.conditionCreator.
Generated using TypeDoc v0.25.12
Provides the configuration for the ValueHostsManager constructor.
NOTE: extensions of this interface can implement IDisposable knowing that the ValueHostManager will call dispose() if supplied, during its own disposal.