Interface IValueHostGenerator

Used by the ValueHostFactory to recognize a specific ValueHost class from the ValueHostConfig and create it, plus create its state.

interface IValueHostGenerator {
    canCreate(config): boolean;
    create(valueHostsManager, config, state): IValueHost;
    cleanupInstanceState(state, config): void;
    createInstanceState(config): ValueHostInstanceState;
}

Implemented by

Index

Methods

canCreate create cleanupInstanceState createInstanceState

Methods

canCreate

canCreate(config): boolean
Determines if it can by used to create the ValueHost instance based on the Config.
Parameters
- config: ValueHostConfig
Returns boolean
Can create when true.
- Defined in packages/jivs-engine/src/Interfaces/ValueHostFactory.ts:54

create

create(valueHostsManager, config, state): IValueHost
Creates the instance.
Parameters
- valueHostsManager: IValueHostsManager
- config: ValueHostConfig
- state: ValueHostInstanceState
Returns IValueHost
- Defined in packages/jivs-engine/src/Interfaces/ValueHostFactory.ts:61

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:69

createInstanceState

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

Generated using TypeDoc v0.25.12