https://github.com/thenativeweb/node-evented-command
provides simple command/event handling for evented systems like cqrs
https://github.com/thenativeweb/node-evented-command
command cqrs event javascript observer
Last synced: 6 months ago
JSON representation
provides simple command/event handling for evented systems like cqrs
- Host: GitHub
- URL: https://github.com/thenativeweb/node-evented-command
- Owner: thenativeweb
- License: mit
- Created: 2012-02-01T12:23:20.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2020-09-01T09:02:42.000Z (about 5 years ago)
- Last Synced: 2025-04-03T01:34:06.292Z (6 months ago)
- Topics: command, cqrs, event, javascript, observer
- Language: JavaScript
- Homepage: http://cqrs.js.org/pages/eventedcommand.html
- Size: 44.9 KB
- Stars: 15
- Watchers: 7
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
# ⚠️ IMPORTANT NEWS! 📰
I’ve been dealing with CQRS, event-sourcing and DDD long enough now that I don’t need working with it anymore unfortunately, so at least for now this my formal farewell!
I want to thank everyone who has contributed in one way or another.
Especially...
- [Jan](https://github.com/jamuhl), who introduced me to this topic.
- [Dimitar](https://github.com/nanov), one of the last bigger contributors and maintainer.
- My last employer, who gave me the possibility to use all these CQRS modules in a big Cloud-System.
- My family and friends, who very often came up short.
Finally, I would like to thank [Golo Roden](https://github.com/goloroden), who was there very early at the beginning of my CQRS/ES/DDD journey and is now here again to take over these modules.
Golo Roden is the founder, CTO and managing director of [the native web](https://www.thenativeweb.io/), a company specializing in native web technologies. Among other things, he also teaches CQRS/ES/DDD etc. and based on his vast knowledge, he brought wolkenkit to life.
[wolkenkit](https://wolkenkit.io) is a CQRS and event-sourcing framework based on Node.js. It empowers you to build and run scalable distributed web and cloud services that process and store streams of domain events.
With this step, I can focus more on [i18next](https://www.i18next.com), [locize](https://locize.com) and [localistars](https://localistars.com). I'm happy about that. 😊
So, there is no end, but the start of a new phase for my CQRS modules 😉
I wish you all good luck on your journey.
Who knows, maybe we'll meet again in a github issue or PR at [i18next](https://github.com/i18next/i18next) 😉
[Adriano Raiano](https://twitter.com/adrirai)
---
# Introduction
[](https://travis-ci.org/adrai/node-evented-command) [](https://npmjs.org/package/evented-command)
Project goal is to provide a simple command/event handling for evented systems like cqrs.
# Installation
npm install evented-command
# Usage
var evtCmd = require('evented-command')();
## Define the command structure [optional]
The values describes the path to that property in the command message.
evtCmd.defineCommand({
id: 'id', // optional
name: 'name', // optional
context: 'context.name', // optional
aggregate: 'aggregate.name', // optional
aggregateId: 'aggregate.id' // optional
});
## Define the event structure [optional]
The values describes the path to that property in the event message.
evtCmd.defineEvent({
correlationId: 'correlationId', // optional
id: 'id', // optional
name: 'name', // optional
context: 'context.name', // optional
aggregate: 'aggregate.name', // optional
aggregateId: 'aggregate.id' // optional
});
## Define the id generator function [optional]
### you can define a synchronous function
evtCmd.idGenerator(function() {
var id = require('uuid').v4().toString();
return id;
});
### or you can define an asynchronous function
evtCmd.idGenerator(function(callback) {
setTimeout(function() {
var id = require('uuid').v4().toString();
callback(null, id);
}, 50);
});
## Wire up commands and events
// pass in events from your bus
bus.on('event', function(data){
evtCmd.emit('event', data);
});
// pass commands to bus
evtCmd.on('command', function(data) {
bus.emit('command', data);
});
## Send commands
var cmd = new Command({
// id: 'my onwn command id', // if you don't pass an id it will generate one, when emitting the command...
name: 'changePerson',
payload: {
name: 'my name'
},
aggregate: {
id: 8,
name: 'jack'
},
context: {
name: 'hr'
}
});
// emit it
cmd.emit();
// if you want to observe the command pass a callback
cmd.emit(function(evt) {
});
// if you want to observe the command that generates any events pass an object like this:
cmd.emit({
event1: function(evt) {
},
event2: function(evt) {
}
});
### Send commands with the speakable api
evtCmd.send('changePerson')
.for('person') // aggregate name
.instance('8') // aggregate id
.in('hr') // context name
.with({
// id: 'my onwn command id', // if you don't pass an id it will generate one, when emitting the command...
revision: '12',
payload: {
name: 'jack'
}
})
.go(function(evt) {
console.log('speakable', evt);
});
evtCmd.send('multi')
.for('aggregate')
.instance('instanceId')
.in('context')
.with({
revision: '43',
payload: 'data2'
})
.go({
event1: function(evt) {
console.log('speakable', evt);
},
event2: function(evt) {
console.log('speakable', evt);
}
});
# License
Copyright (c) 2016 Adriano Raiano
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.