Class RuleForge

Hierarchy

RuleForge

Constructors

constructor

new RuleForge(knowledgeBase?): RuleForge
Parameters
- Optional knowledgeBase: KnowledgeBase
Returns RuleForge
- Defined in ruleset/ruleset.ts:606

Properties

`Private` _factMap

_factMap: Map<string, Fact> = ...

`Private` _rulesetMap

_rulesetMap: Map<string, Ruleset> = ...

`Private` baseAction

baseAction: IAction = ...

`Private` knowledgeBase

knowledgeBase: KnowledgeBase = ...

`Private` lastResult

lastResult: Result = ...

`Private` lastResults

lastResults: Result[] = []

`Private` lastRule

lastRule: string = ''

`Private` lastRuleset

lastRuleset: string = ''

Methods

AddAction

AddAction(actionFunction): RuleForge
Parameters
- actionFunction: ((obj?) => void)
  - - (obj?): void
    - Parameters
      
      Optional obj: any
      
      Returns void
Returns RuleForge
- Defined in ruleset/ruleset.ts:673

AddActionToRule

AddActionToRule(rulesetName, ruleName, actionFunction): RuleForge
Parameters
- rulesetName: string
- ruleName: string
- actionFunction: ((obj?) => void)
  - - (obj?): void
    - Parameters
      
      Optional obj: any
      
      Returns void
Returns RuleForge
- Defined in ruleset/ruleset.ts:719

AddCondition

AddCondition(conditionName, testFunction): RuleForge
Parameters
- conditionName: string
- testFunction: ((fact, knowledgeBase?) => string)
  - - (fact, knowledgeBase?): string
    - Parameters
      
      fact: Fact
      
      Optional knowledgeBase: IKnowledgeBase
      
      Returns string
Returns RuleForge
- Defined in ruleset/ruleset.ts:765

AddConditionToRule

AddConditionToRule(rulesetName, ruleName, conditionName, testFunction): RuleForge
Parameters
- rulesetName: string
- ruleName: string
- conditionName: string
- testFunction: ((fact, knowledgeBase?) => string)
  - - (fact, knowledgeBase?): string
    - Parameters
      
      fact: Fact
      
      Optional knowledgeBase: IKnowledgeBase
      
      Returns string
Returns RuleForge
- Defined in ruleset/ruleset.ts:778

AddFact

AddFact(factName, fact): RuleForge
Parameters
- factName: string
- fact: Fact
Returns RuleForge
- Defined in ruleset/ruleset.ts:844

AddKnowledgeAction

AddKnowledgeAction(actionFunction, name, subject, attribute, value): RuleForge
Parameters
- actionFunction: ((obj?) => void)
  - - (obj?): void
    - Parameters
      
      Optional obj: any
      
      Returns void
- name: string
- subject: string
- attribute: string
- value: any
Returns RuleForge
- Defined in ruleset/ruleset.ts:685

AddKnowledgeActionToRule

AddKnowledgeActionToRule(rulesetName, ruleName, actionFunction, name, subject, attribute, value): RuleForge
Parameters
- rulesetName: string
- ruleName: string
- actionFunction: ((obj?) => void)
  - - (obj?): void
    - Parameters
      
      Optional obj: any
      
      Returns void
- name: string
- subject: string
- attribute: string
- value: any
Returns RuleForge
- Defined in ruleset/ruleset.ts:728

AddRelationshipAction

AddRelationshipAction(actionFunction, name, description, subject?, relation?): RuleForge
Parameters
- actionFunction: ((obj?) => void)
  - - (obj?): void
    - Parameters
      
      Optional obj: any
      
      Returns void
- name: string
- description: string
- subject: string = ''
- relation: string = ''
Returns RuleForge
- Defined in ruleset/ruleset.ts:704

AddRelationshipActionToRule

AddRelationshipActionToRule(rulesetName, ruleName, actionFunction, name, description, subject, relation): RuleForge
Parameters
- rulesetName: string
- ruleName: string
- actionFunction: ((obj?) => void)
  - - (obj?): void
    - Parameters
      
      Optional obj: any
      
      Returns void
- name: string
- description: string
- subject: string
- relation: string
Returns RuleForge
- Defined in ruleset/ruleset.ts:744

AddRule

AddRule(ruleName, action?): RuleForge
Parameters
- ruleName: string
- action: IAction = ...
Returns RuleForge
- Defined in ruleset/ruleset.ts:642

AddRuleToRuleset

AddRuleToRuleset(rulesetName, ruleName, action?): RuleForge
Parameters
- rulesetName: string
- ruleName: string
- action: IAction = ...
Returns RuleForge
- Defined in ruleset/ruleset.ts:655

BulkRunRules

BulkRunRules(fireOnPass?, failOnInfinite?): RuleForge
Parameters
- fireOnPass: boolean = true
- failOnInfinite: boolean = false
Returns RuleForge
- Defined in ruleset/ruleset.ts:860

BulkRunRulesOnRuleset

BulkRunRulesOnRuleset(rulesetName, fireOnPass?, failOnInfinite?): RuleForge
Parameters
- rulesetName: string
- fireOnPass: boolean = true
- failOnInfinite: boolean = false
Returns RuleForge
- Defined in ruleset/ruleset.ts:877

ClearActionFromRule

ClearActionFromRule(rulesetName, ruleName): RuleForge
Parameters
- rulesetName: string
- ruleName: string
Returns RuleForge
- Defined in ruleset/ruleset.ts:756

DeleteFact

DeleteFact(factName): RuleForge
Parameters
- factName: string
Returns RuleForge
- Defined in ruleset/ruleset.ts:854

FireAllPasses

FireAllPasses(obj?): RuleForge
Parameters
- Optional obj: any
Returns RuleForge
- Defined in ruleset/ruleset.ts:833

GetBulkResults

GetBulkResults(): Result[]
Returns Result[]
- Defined in ruleset/ruleset.ts:890

GetFact

GetFact(factName): undefined | Fact
Parameters
- factName: string
Returns undefined | Fact
- Defined in ruleset/ruleset.ts:850

GetLastResult

GetLastResult(): Result
Returns Result
- Defined in ruleset/ruleset.ts:807

GetResults

GetResults(): Result[]
Returns Result[]
- Defined in ruleset/ruleset.ts:815

GetResultsOnRuleset

GetResultsOnRuleset(rulesetName): Result[]
Parameters
- rulesetName: string
Returns Result[]
- Defined in ruleset/ruleset.ts:826

NewRuleset

NewRuleset(name): RuleForge
Parameters
- name: string
Returns RuleForge
- Defined in ruleset/ruleset.ts:610

RemoveConditionFromRule

RemoveConditionFromRule(rulesetName, ruleName, conditionName): RuleForge
Parameters
- rulesetName: string
- ruleName: string
- conditionName: string
Returns RuleForge
- Defined in ruleset/ruleset.ts:787

RemoveRuleFromRuleset

RemoveRuleFromRuleset(rulesetName, ruleName): RuleForge
Parameters
- rulesetName: string
- ruleName: string
Returns RuleForge
- Defined in ruleset/ruleset.ts:664

RemoveRuleset

RemoveRuleset(name): RuleForge
Parameters
- name: string
Returns RuleForge
- Defined in ruleset/ruleset.ts:618

RunRules

RunRules(fact, fireOnPass?, failOnInfinite?): RuleForge
Parameters
- fact: Fact
- fireOnPass: boolean = true
- failOnInfinite: boolean = false
Returns RuleForge
- Defined in ruleset/ruleset.ts:796

`Private` ruleCheck

ruleCheck(): void
Returns void
- Defined in ruleset/ruleset.ts:637

`Private` ruleError

ruleError(rulesetName): string
Parameters
- rulesetName: string
Returns string
- Defined in ruleset/ruleset.ts:633

`Private` rulesetError

rulesetError(): string
Returns string
- Defined in ruleset/ruleset.ts:625

`Private` rulesetNameError

rulesetNameError(rulesetName): string
Parameters
- rulesetName: string
Returns string
- Defined in ruleset/ruleset.ts:629

Generated using TypeDoc