Interface IValueHostConfigMergeService

Interface for all ConfigMergeServices built for the ValueHostConfig and its subclasses.

interface IValueHostConfigMergeService {
    serviceName: string;
    services: IServices;
    setPropertyConflictRule(propertyName, rule): void;
    getNoChangePropertyNames(): string[];
    merge(source, destination): void;
    identifyValueHostConflict(source, destinations): undefined | ValueHostConfig;
    dispose(): void;
}

Hierarchy (view full)

IConfigMergeServiceBase<ValueHostConfig>
- IValueHostConfigMergeService

Implemented by

ValueHostConfigMergeService

Index

Properties

serviceName services

Methods

setPropertyConflictRule getNoChangePropertyNames merge identifyValueHostConflict dispose

Properties

serviceName

serviceName: string

services

services: IServices

Provides access to services.

Methods

setPropertyConflictRule

setPropertyConflictRule(propertyName, rule): void
Assigns the rule for a property on any Config and subclass. Once assigned, some rules allow change and others, like 'locked' cannot be changed and throw an error. If no rule has been assigned to a property, merge() assumes "replace" for that property.
Parameters
- propertyName: string
- rule: PropertyConflictRule<ValueHostConfig>
Returns void
Inherited from IConfigMergeServiceBase.setPropertyConflictRule
- Defined in packages/jivs-engine/src/Interfaces/ConfigMergeService.ts:23

getNoChangePropertyNames

getNoChangePropertyNames(): string[]
Exposes property names that are not expected to be changed by the rules. Ignores rules with functions. Intent is to allow ValueHostsManagerConfigModifier to know of properties to strip out instead of allowing them to make it into the merge code.

Returns string[]
Inherited from IConfigMergeServiceBase.getNoChangePropertyNames
- Defined in packages/jivs-engine/src/Interfaces/ConfigMergeService.ts:32

merge

merge(source, destination): void
Attempts to merge the source's properties into the destination. It only makes changes to the destination based on the rules of setPropertyConfigRule()
Parameters
- source: ValueHostConfig
- destination: ValueHostConfig
Returns void
- Defined in packages/jivs-engine/src/Interfaces/ConfigMergeService.ts:44

identifyValueHostConflict

identifyValueHostConflict(source, destinations): undefined | ValueHostConfig
Identifies a ValueHostConfig in the destination that should be merged with the source. If none need to be merged, it returns null and the caller should add their ValueHostConfig to ValidationManagerConfig.ValueHostConfigs.
Parameters
- source: ValueHostConfig
- destinations: ValueHostConfig[]
Returns undefined | ValueHostConfig
- Defined in packages/jivs-engine/src/Interfaces/ConfigMergeService.ts:53

dispose

dispose(): void
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.

Returns void
Inherited from IConfigMergeServiceBase.dispose
- Defined in packages/jivs-engine/src/Interfaces/General_Purpose.ts:17

Generated using TypeDoc v0.25.12