Class MockConditionBase<TConfig>`Abstract`

Base class for custom conditions designed for testing validation where the Condition has a predictable behavior.

Type Parameters

TConfig extends ConditionConfig

Hierarchy (view full)

MockConditionBase

Implements

IConditionCore<TConfig>

Index

Constructors

Accessors

conditionType config category

Methods

Constructors

constructor

new MockConditionBase<TConfig>(config): MockConditionBase<TConfig>
Type Parameters
- TConfig extends ConditionConfig
Parameters
- config: TConfig
Returns MockConditionBase<TConfig>
- Defined in packages/jivs-engine/src/Support/conditionsForTesting.ts:65

Accessors

conditionType

get conditionType(): string
A unique identifier for the specific implementation, like "RequireText" or "Range". Its value appears in the IssueFound.errorCode property unless overridden in ValidatorConfig.errorCode. It allows the consumer of both to correlate those instances with the specific condition. When defining conditions through a ConditionConfig, the conditionType property must be assigned with a valid ConditionType.

Returns string
Implementation of IConditionCore.conditionType
- Defined in packages/jivs-engine/src/Support/conditionsForTesting.ts:69

config

get config(): TConfig
Data that supports the business rule defined in evaluate(). Consider this immutable. Expect to create a new Condition instance if its data needs to be changed.

Returns TConfig
Implementation of IConditionCore.config
- Defined in packages/jivs-engine/src/Support/conditionsForTesting.ts:76

category

get category(): ConditionCategory
Helps identify the purpose of the Condition. Impacts:
- Sort order of the list of Conditions evaluated by an Validator, placing Require first and DataTypeCheck second.
- Sets InputValueHostConfig.requiresInput.
- Sets ValidatorConfig.severity when undefined, where Require and DataTypeCheck will use Severe. Others will use Error. Many Conditions have this value predefined. However, all will let the user override it with ConditionConfig.category.
Returns ConditionCategory
Implementation of IConditionCore.category
- Defined in packages/jivs-engine/src/Support/conditionsForTesting.ts:81

Methods

`Abstract` evaluate

evaluate(valueHost, valueHostResolver): ConditionEvaluateResult | Promise<ConditionEvaluateResult>
Evaluate something against the rules defined in the implementation. Return whether the data was consistent or violates the rules, or the data couldn't be used to run the rule.
Parameters
- valueHost: null | IValueHost
  Most values are found amongst the ValueHosts in the ValueHostsManager. Conditions can look them up using ValueHostsManager.getValueHost().getValue() or getInputValue(). This parameter is used as an optimization, both to avoid that lookup and to avoid the user typing in a ValueHostName when creating the Condition instance. Validator.validate() knows to pass the ValueHostName that hosts the Validator. Expect this to be null in other cases, such as when Condition is a child of the AllMatchCondition and its peers. In otherwords, support both ways.
- valueHostResolver: IValueHostResolver
  Its primary use is to lookup ValueHosts to get their data.
Returns ConditionEvaluateResult | Promise<ConditionEvaluateResult>
Any of these values:
- Match - consistent with the rule
- NoMatch - violates the rule
- Undetermined - Cannot invoke the rule. Usually data incompatible with use within the rule, like the value is null, undefined, or the wrong data type.
Implementation of IConditionCore.evaluate
- Defined in packages/jivs-engine/src/Support/conditionsForTesting.ts:74

Generated using TypeDoc v0.25.12