Class IfThenRule

A conditional rule that is executed if a condition is satisified.

Hierarchy (View Summary)

AbstractRule
- IfThenRule

Constructors

`Protected`constructor

new IfThenRule(
    syntax: string,
    condition?: Expression | null,
    consequence?: ExecutableAction | null,
    checker?: TypeChecker,
): IfThenRule
Parameters
- syntax: string
- Optionalcondition: Expression | null
- Optionalconsequence: ExecutableAction | null
- Optionalchecker: TypeChecker
Returns IfThenRule
Overrides AbstractRule.constructor
- Defined in src/rules/conditional.rules.ts:40

Properties

`Optional`name

name?: string

Optional name for the rule, which can be used for identification and debugging purposes.

`Optional`hint

hint?: string

An optional hint or description for the rule, which can provide additional information about its purpose or usage. This is primarily for documentation and user guidance when working with the rule.

`Protected`changeTargets

changeTargets: Record<string, AtomicType | ArrayType | ObjectType>

`Protected` `Optional`compiled_eval

compiled_eval?: Function

`Protected`condition

condition: Expression

`Protected`consequence

consequence: ExecutableAction

Methods

getSyntax

getSyntax(): string
Get the original syntax string from which this rule was created. This can be useful for debugging and error reporting, as it allows you to see the exact rule definition that led to a particular rule instance.

Returns string
the original syntax string of the rule.
Inherited from AbstractRule.getSyntax
- Defined in src/rules/abstract.rule.ts:50

getSalience

getSalience(): number
Get the salience (priority) of the rule, which determines the order in which rules are evaluated and executed when multiple rules are applicable. Higher salience means higher priority. If salience is not set, it defaults to 0.

Returns number
the salience (priority) of the rule where 0 is default and 10 is the highest.
Inherited from AbstractRule.getSalience
- Defined in src/rules/abstract.rule.ts:58

setSalience

setSalience(salience: number): void
Set the salience (priority) of the rule, which determines the order in which rules are evaluated and executed when multiple rules are applicable. Higher salience means higher priority. If salience is not set, it defaults to 0.
Parameters
- salience: number
  the salience (priority) of the rule where 0 is default and 10 is the highest.
Returns void
Inherited from AbstractRule.setSalience
- Defined in src/rules/abstract.rule.ts:66

isDisabled

isDisabled(): boolean
Check whether the rule is currently disabled. A disabled rule will not be evaluated or executed by the engine.

Returns boolean
true if the rule is disabled, false otherwise.
Inherited from AbstractRule.isDisabled
- Defined in src/rules/abstract.rule.ts:74

disable

disable(reason?: string): void
Disable the rule, preventing it from being evaluated or executed by the engine. This can be useful for temporarily turning off rules without removing them from the system, such as during testing. Optionally, a reason can be provided for why the rule is being disabled, which will be included in the hint if no hint is already set for the rule.
Parameters
- Optionalreason: string
  a hint or reason for why the rule is being disabled.
Returns void
Inherited from AbstractRule.disable
- Defined in src/rules/abstract.rule.ts:84

enable

enable(): void
Enable the rule, allowing it to be evaluated and executed by the engine if it is applicable. This can be used to re-enable a rule that was previously disabled.

Returns void
Inherited from AbstractRule.enable
- Defined in src/rules/abstract.rule.ts:95

annotate

annotate(annotation: string, value: unknown): void
Parameters
- annotation: string
- value: unknown
Returns void
Inherited from AbstractRule.annotate
- Defined in src/rules/abstract.rule.ts:99

isAnnotated

isAnnotated(annotation: string, value?: unknown): boolean
Parameters
- annotation: string
- Optionalvalue: unknown
Returns boolean
Inherited from AbstractRule.isAnnotated
- Defined in src/rules/abstract.rule.ts:125

getAnnotation

getAnnotation(annotation: string): unknown
Parameters
- annotation: string
Returns unknown
Inherited from AbstractRule.getAnnotation
- Defined in src/rules/abstract.rule.ts:139

getAnnotations

getAnnotations(): Record<string, unknown>
Returns Record<string, unknown>
Inherited from AbstractRule.getAnnotations
- Defined in src/rules/abstract.rule.ts:150

`Protected`require

require(...requirements: string[]): void
Parameters
- ...requirements: string[]
Returns void
Inherited from AbstractRule.require
- Defined in src/rules/abstract.rule.ts:168

required

required(): Set<string>
What data keys are required for this rule to be applicable? This is determined by the specific implementation of the rule and should be set during the construction of the instance. The rule engine uses this information to determine which rules are applicable based on the current context.

Returns Set<string>
a set of data keys required for this rule to be applicable.
Inherited from AbstractRule.required
- Defined in src/rules/abstract.rule.ts:180

`Protected`willChange

willChange(changes: Record<string, AtomicType | ArrayType | ObjectType>): void
Declare what keys (and their types) that are expected in the relevant context when this rule is executed.
Parameters
- changes: Record<string, AtomicType | ArrayType | ObjectType>
  a record mapping changed data keys to their expected types.
Returns void
Inherited from AbstractRule.willChange
- Defined in src/rules/abstract.rule.ts:188

applicable

applicable(context: WorkingContext): boolean
Whether this rule is applicable in the given context, based on whether all of its required data keys are present in the context.
Parameters
- context: WorkingContext
  the current working context containing data and constants.
Returns boolean
true if the rule is applicable, false otherwise.
Inherited from AbstractRule.applicable
- Defined in src/rules/abstract.rule.ts:202

`Static`parse

parse(syntax: string, workspace?: Workspace): IfThenRule
Parameters
- syntax: string
- Optionalworkspace: Workspace
Returns IfThenRule
- Defined in src/rules/conditional.rules.ts:23

getExpression

getExpression(): Expression
The condition to be evaluated and satisified.

Returns Expression
the expression to be evaluated in this rule.
Overrides AbstractRule.getExpression
- Defined in src/rules/conditional.rules.ts:32

`Static`parsed

parsed(
    syntax: string,
    condition: Expression,
    consequence: ExecutableAction,
    checker?: TypeChecker,
): IfThenRule
Parameters
- syntax: string
- condition: Expression
- consequence: ExecutableAction
- Optionalchecker: TypeChecker
Returns IfThenRule
- Defined in src/rules/conditional.rules.ts:36

toString

toString(): string
Returns a string representation of an object.

Returns string
Overrides AbstractRule.toString
- Defined in src/rules/conditional.rules.ts:68

toJson

toJson(): Renderable
Returns Renderable
Overrides AbstractRule.toJson
- Defined in src/rules/conditional.rules.ts:72

checkTypes

checkTypes(checker?: TypeChecker): ValidationResult
Check the types of the rule using the provided type checker. This method should validate that all expressions and components of the rule are type-correct according to the types known to the checker instance.
Parameters
- Optionalchecker: TypeChecker
  the type checker to use for validating the rule.
Returns ValidationResult
the result of the type check, indicating whether the rule is valid.
Overrides AbstractRule.checkTypes
- Defined in src/rules/conditional.rules.ts:80

typedChanges

typedChanges(
checker?: TypeChecker,
): Record<string, AtomicType | ArrayType | ObjectType>
Get the data keys that this executor will change when executed, along with their expected types.
Parameters
- Optionalchecker: TypeChecker
Returns Record<string, AtomicType | ArrayType | ObjectType>
a record mapping data keys to their expected types.
Overrides AbstractRule.typedChanges
- Defined in src/rules/conditional.rules.ts:87

evaluate

evaluate(context: WorkingContext): Executor | null
Evaluate the rule in the given context to determine if it is satisfied and should be executed.
Parameters
- context: WorkingContext
  the current working context containing data and constants.
Returns Executor | null
an executor if the rule is satisfied, null otherwise.
Overrides AbstractRule.evaluate
- Defined in src/rules/conditional.rules.ts:94

execute

execute(context: WorkingContext): RuleEffect
Execute the rule in the given context and return the effect of the execution. This method should only be called if the rule has been evaluated and found to be satisfied.
Parameters
- context: WorkingContext
  the current working context containing data and constants.
Returns RuleEffect
the effect of executing the rule.
Overrides AbstractRule.execute
- Defined in src/rules/conditional.rules.ts:101

Class IfThenRule

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns IfThenRule

Properties

Optionalname

Optionalhint

ProtectedchangeTargets

Protected Optionalcompiled_eval

Protectedcondition

Protectedconsequence

Methods

getSyntax

Returns string

getSalience

Returns number

setSalience

Parameters

Returns void

isDisabled

Returns boolean

disable

Parameters

Returns void

enable

Returns void

annotate

Parameters

Returns void

isAnnotated

Parameters

Returns boolean

getAnnotation

Parameters

Returns unknown

getAnnotations

Returns Record<string, unknown>

Protectedrequire

Parameters

Returns void

required

Returns Set<string>

ProtectedwillChange

Parameters

Returns void

applicable

Parameters

Returns boolean

Staticparse

Parameters

Returns IfThenRule

getExpression

Returns Expression

Staticparsed

Parameters

Returns IfThenRule

toString

Returns string

toJson

Returns Renderable

checkTypes

Parameters

Returns ValidationResult

typedChanges

Parameters

Returns Record<string, AtomicType | ArrayType | ObjectType>

evaluate

Parameters

Returns Executor | null

execute

Parameters

Returns RuleEffect

Settings

On This Page

`Protected`constructor

`Optional`name

`Optional`hint

`Protected`changeTargets

`Protected` `Optional`compiled_eval

`Protected`condition

`Protected`consequence

`Protected`require

`Protected`willChange

`Static`parse

`Static`parsed