Interface IConditionFactory

Creates instances of Conditions given an ConditionConfig. ConditionConfig.conditionType is used to determine the Condition class to create.

interface IConditionFactory {
    create(config): ICondition;
    register<TConfig>(conditionType, fn): void;
    findRealName(conditionType): null | string;
}

Implemented by

ConditionFactory

Index

Methods

create register findRealName

Methods

create

create(config): ICondition
Create an instance of a Condition from the ConditionConfig.
Parameters
- config: ConditionConfig
Returns ICondition
- Defined in packages/jivs-engine/src/Interfaces/Conditions.ts:298

register

register<TConfig>(conditionType, fn): void
Add or replace a function to create an instance of the Condition given a ConditionConfig.
Type Parameters
- TConfig extends ConditionConfig
Parameters
- conditionType: string
  Unique way to select the function. Uses ConditionConfig.conditionType.
- fn: ((config) => IConditionCore<TConfig>)
  Expected to create an instance of a Condition.
  - - (config): IConditionCore<TConfig>
    - Parameters
      config: TConfig
      Returns IConditionCore<TConfig>
Returns void
- Defined in packages/jivs-engine/src/Interfaces/Conditions.ts:306

findRealName

findRealName(conditionType): null | string
Helper to see if the conditionType value is registered even when its case is different or it has whitespace that needs trimming.
Parameters
- conditionType: string
Returns null | string
The real name of the conditionType or null if not found.
- Defined in packages/jivs-engine/src/Interfaces/Conditions.ts:315

Interface IConditionFactory

Implemented by

Index

Methods

Methods

create

Parameters

Returns ICondition

register

Type Parameters

Parameters

Parameters

Returns IConditionCore<TConfig>

Returns void

findRealName

Parameters

Returns null | string

Settings

Member Visibility

Theme

On This Page