Interface IValueHostFactory

Interface for creating ValueHostFactory classes.

interface IValueHostFactory {
    create(valueHostsManager, config, state): IValueHost;
    cleanupInstanceState(state, config): void;
    createInstanceState(config): ValueHostInstanceState;
    ensureRegistered(config): void;
}

Implemented by

ValueHostFactory

Index

Methods

create cleanupInstanceState createInstanceState ensureRegistered

Methods

create

create(valueHostsManager, config, state): IValueHost
Creates the instance.
Parameters
- valueHostsManager: IValueHostsManager
- config: ValueHostConfig
  determines the class. All classes supported here must ValueHostConfig to get their setup.
- state: ValueHostInstanceState
  Allows restoring the state of the new ValueHost instance. Use Factory.createInstanceState() to create an initial value.
Returns IValueHost
- Defined in packages/jivs-engine/src/Interfaces/ValueHostFactory.ts:21

cleanupInstanceState

cleanupInstanceState(state, config): void
Adjusts the state from a previous time to conform to the Config. For example, if the Config had a rule change, some data in the state may be obsolete and can be discarded.
Parameters
- state: ValueHostInstanceState
- config: ValueHostConfig
Returns void
- Defined in packages/jivs-engine/src/Interfaces/ValueHostFactory.ts:29

createInstanceState

createInstanceState(config): ValueHostInstanceState
Creates an initialized InstanceState object
Parameters
- config: ValueHostConfig
Returns ValueHostInstanceState
- Defined in packages/jivs-engine/src/Interfaces/ValueHostFactory.ts:34

ensureRegistered

ensureRegistered(config): void
Confirms that the ValueHostConfig matches to a registered ValueHostGenerator. Throws if not found.
Parameters
- config: ValueHostConfig
Returns void
- Defined in packages/jivs-engine/src/Interfaces/ValueHostFactory.ts:41

Generated using TypeDoc v0.25.12