node-rules

    7.1.0 • Public • Published

    Build Status npm npm version Coverage Status npm downloads install size install size Known Vulnerabilities CDNJS

    Node Rules

    Node-rules is a light weight forward chaining Rule Engine, written in JavaScript for both browser and node.js environments.

    Installation

    npm install node-rules
    

    Sample Screencast

    Try This Out!

    You can see this in action in a node.js environment using this RunKit example. If you are interested to use it in the browser, use this JSFiddle for a quick start.

    Overview

    Node-rules takes rules written in JSON friendly format as input. Once the rule engine is running with rules registered on it, you can feed it facts and the rules will be applied one by one to generate an outcome.

    1. Defining a Rule

    A rule will consist of a condition and its corresponding consequence. You can find the explanation for various mandatory and optional parameters of a rule in this wiki.

    {
        "condition" : function(R) {
            R.when(this.transactionTotal < 500);
        },
        "consequence" : function(R) {
            this.result = false;
            R.stop();
        }
    }

    Here priority is an optional parameter which will be used to specify priority of a rule over other rules when there are multiple rules running. In the above rule R.when evaluates the condition expression and R.stop used to stop further processing of the fact as we have arrived at a result.

    The functions R.stop, R.when, R.next, R.restart are part of the Flow Control API which allows user to control the Engine Flow. Read more about Flow Controls in wiki.

    2. Defining a Fact

    Facts are those input json values on which the rule engine applies its rule to obtain results. A fact can have multiple attributes as you decide.

    A sample Fact may look like

    {
      "name":"user4",
      "application":"MOB2",
      "transactionTotal":400,
      "cardType":"Credit Card",
    }
    
    3. Using the Rule Engine

    The example below shows how to use the rule engine to apply a sample rule on a specific fact. Rules can be fed into the rule engine as Array of rules or as an individual rule object.

    var RuleEngine = require("node-rules");
    
    /* Creating Rule Engine instance */
    var R = new RuleEngine();
    
    /* Add a rule */
    var rule = {
        "condition": function(R) {
            console.log(this);
            R.when(this.transactionTotal < 500);
        },
        "consequence": function(R) {
            this.result = false;
            this.reason = "The transaction was blocked as it was less than 500";
            R.stop();
        }
    };
    
    /* Register Rule */
    R.register(rule);
    
    /* Add a Fact with less than 500 as transaction, and this should be blocked */
    var fact = {
        "name": "user4",
        "application": "MOB2",
        "transactionTotal": 400,
        "cardType": "Credit Card"
    };
    
    /* Check if the engine blocks it! */
    R.execute(fact, function (data) {
        if (data.result) {
            console.log("Valid transaction");
        } else {
            console.log("Blocked Reason:" + data.reason);
        }
    });
    4. Controlling Rules running on the Rule Engine

    If you are looking for ways to specify the order in which the rules get applied on a fact, it can be done via using the priority parameter. Read more about it in the Rule wiki. If you need to know about how to change priority of rules or remove add new rules to a Running Rule Engine, you may read more about it in Dynamic Control Wiki.

    5. Exporting Rules to an external storage

    To read more about storing rules running on the engine to an external DB, refer this wiki article.

    Wiki

    To read more about the Rule engine functions, please read the wiki here!. To find more examples of implementation please look in the examples folder.

    Issues

    Got issues with the implementation?. Feel free to open an issue here.

    Licence

    Node rules is distributed under the MIT License.

    External References

    Credits

    The JSON friendly rule formats used in version 2.x.x of this module were initially based on the node module jools. The screencast image shown in this page is taken from nmotv.in which has a pretty nice article on how to use this module!

    Install

    npm i node-rules

    DownloadsWeekly Downloads

    1,690

    Version

    7.1.0

    License

    MIT

    Unpacked Size

    74.1 kB

    Total Files

    21

    Last publish

    Collaborators

    • mithunsatheesh
    • mendax