RuleEngine

Ordered condition/effect rule evaluator connecting WorldFacts and TypedEventBus with priority order, condition checks, action execution, stopPropagation support, and decision trace logging.

Constructor

new RuleEngine(optionsOrFactsopt, maybeBusopt, maybeOptionsopt)

Parameters:
NameTypeAttributesDefaultDescription
optionsOrFactsWorldFacts | object<optional>
maybeBusTypedEventBus<optional>
null
maybeOptionsobject<optional>

Classes

RuleEngine

Members

ruleCount

Total number of registered rules.

Methods

addRule(ruleDef) → {function}

Adds an ordered condition/effect rule.

Parameters:
NameTypeDescription
ruleDefobject
Properties
NameTypeAttributesDefaultDescription
idstring<optional>

Unique rule identifier

namestring<optional>

Human readable name

prioritynumber<optional>
0

Higher executes first

eventstring | Array.<string><optional>

Event(s) to bind on TypedEventBus

conditionfunction | boolean<optional>

Condition check

actionfunction<optional>

Action effect

stopPropagationboolean<optional>
false

If true, halts further rules/listeners on execution

enabledboolean<optional>
true
Returns:

Unbind function

Type: 
function

clearDecisionTraces()

Clears all recorded decision traces.

clearRules()

Unbinds and clears all registered rules.

disableRule(ruleId)

Disables a rule.

Parameters:
NameTypeDescription
ruleIdstring

dispose()

Cleans up all rules and decision traces.

enableRule(ruleId)

Enables a rule.

Parameters:
NameTypeDescription
ruleIdstring

evaluate(eventTypeopt, eventDataopt, optionsopt) → {Object}

Evaluates matching rules in priority order against facts and event data.

Parameters:
NameTypeAttributesDefaultDescription
eventTypestring | null<optional>
null
eventDataany<optional>
{}
optionsobject<optional>
Returns:
Type: 
Object

getDecisionTraces(filteropt) → {Array.<object>}

Retrieves recorded decision traces with optional filtering.

Parameters:
NameTypeAttributesDescription
filterobject<optional>
Returns:
Type: 
Array.<object>

getLastDecisionTrace() → {object|null}

Returns the most recent decision trace.

Returns:
Type: 
object | null

getRule(ruleId) → {object|null}

Returns a rule definition by ID.

Parameters:
NameTypeDescription
ruleIdstring
Returns:
Type: 
object | null

hasRule(ruleId) → {boolean}

Checks if a rule is registered.

Parameters:
NameTypeDescription
ruleIdstring
Returns:
Type: 
boolean

removeRule(ruleId) → {boolean}

Removes a rule and cleans up all its event bus subscriptions.

Parameters:
NameTypeDescription
ruleIdstring
Returns:
Type: 
boolean