If the user needs to abandon this instance, they should use this to clean up active resources (like timers) and to release memory that would stall the garbage collector from disposing this object. It should assign any object reference to undefined as a strong indicator that the object has been disposed.
Fluent format to create a StaticValueHostConfig. This is the start of a fluent series. However, at this time, there are no further items in the series.
the ValueHost name
Optional dataType: null | stringoptional and can be null. The value for ValueHost.dataType.
Optional parameters: FluentStaticParametersoptional. Any additional properties of a StaticValueHostConfig.
Same instance for chaining.
Fluent format to create a StaticValueHostConfig. This is the start of a fluent series. However, at this time, there are no further items in the series.
the ValueHost name
optional. Any additional properties of a StaticValueHostConfig.
Same instance for chaining.
Fluent format to create a StaticValueHostConfig. This is the start of a fluent series. However, at this time, there are no further items in the series.
Supply the entire StaticValueHostConfig. This is a special use case. You can omit the valueHostType property.
Same instance for chaining.
Optional arg2: null | string | FluentStaticParametersOptional parameters: FluentStaticParametersFluent format to create a CalcValueHostConfig. This is the start of a fluent series. However, at this time, there are no further items in the series.
the ValueHost name
can be null. The value for ValueHost.dataType.
required. Function callback.
Same instance for chaining.
Fluent format to create a CalcValueHostConfig. This is the start of a fluent series. However, at this time, there are no further items in the series.
Supply the entire CalcValueHostConfig. This is a special use case. You can omit the valueHostType property.
Same instance for chaining.
Optional dataType: null | stringOptional calcFn: CalculationHandlerCompletes the process by using ValueHostManager.addOrMergeValueHost() on each entry supplied. That function internally uses ValueHostsConfigMergeService when the ValueHost exists. After this function completes, this instance has been disposed (via dispose() function) and the instance should not be used further. Any reference to a ValueHost instance that you have must be abandoned and a fresh instance retrieved, as your reference was disposed.
Generated using TypeDoc v0.25.12
Used by ValueHostManager.startModifying() function to modify the ValueHostsManagerConfig.valueHostConfigs array. It does not change the original until you call its apply() function. apply() makes its updates through ValueHostsManager.addOrMergeValueHost().