lirenhao / cqrs

CQRS-DDD-Actor framework for Node.js

API DOC

DDD-CQRS-Actor framework for javascript.

Schematic diagram

Understand ActorListener

Install

npm install cqrs --save

Test

npm test

Use

Step 1 . create a domain

var Domain = require("cqrs").Domain;
var Actor = require("cqrs").Actor;
var domain = new Domain(options);  // create a cqrs domain

• options for eventstore , see eventstore - Provide implementation for storage

Step 2 . create a actor class

// use es5 extend tool
var extend = require("cqrs").extend;    
var User = extend({

   type:'User',
   
   init(data){
       data.name = '';
       data.accessNum = 0;
   },
   
   when:function(event){
       switch(event.name){
           case "changeName":
               this._data.name = event.name;
           break;
       }
   },

   changeName:function(name){
       this.apply("changeName",name);
   }
});


--- or use es6 class ---

class User extends Actor{

    static get type(){
       return 'User';
    }
    
    constructor(data){
        super({
            name;'',
            accessNum:0
        });
    }

    when(event){
        switch(event.name){
            case "changeName":
                this._data.name = event.name;
            break;
        }
    }

    changeName(name){
        this.apply("changeName",name);
    }
    
    access(){
        this.apply("access");
    }

}

Step 3 . register actor class to domain

domain.register(User);

Step 4 . listen domain's event

domain.on("User.changeName",function(event){
    // ......
})

Step 5 . actor operating

// create a user
domain.create("User",{name:"leo"},function(err,userId){
    ......
});


// get a user object
domain.get("User",userId,function(err,actor){

});

// or

domain.get("User",userId).then(function(actor){
    actor.changeName("leo giese");
});

// or

domain.call('User',userId,'changeName',['leo giese']);  // return a promise object
domain.call(`User.${userId}.changeName`,['leo giese']); 
domain.call(['User',userId,'changeName'],['leo giese']);
domain.call(`User.${userId}.changeName`,['leo giese'],function(err,result){ ... });

// if no need arguments
domain.call('User',userId,'access'); 
domain.call('User.${userId}.access'); 
domain.call(['User',userId,'access']); 

Advanced Usage

Actor listen domain'event, and handle.

export default
class Transfer extends Actor {

    static get type() {
        return "Transfer";
    }

    transfer(fromId, toId, money) {
        ......

        this.listen("User." + fromId + ":deduct&" + this.id, "__userDeduct");
        this.listen("User." + toId + ":recharge&" + this.id, "__userRecharge");

        ......
    }

    // event handle method
    __userDeduct(event) {
        ......
    }

    __userRecharge(event) {
        ......
    }

}

LICENSE

MIT