├── .gitignore
├── example
    ├── node
    │   └── app.js
    └── browser
    │   └── example.html
├── package.json
├── LICENSE
├── lib
    └── eventbus.min.js
├── src
    └── EventBus.js
└── README.md


/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | *.log


--------------------------------------------------------------------------------
/example/node/app.js:
--------------------------------------------------------------------------------
1 | var EventBus = require('../../lib/eventbus.min');
2 | 
3 | function myFunction(event) {
4 |   console.log('myFunction type=' + event.type);
5 | }
6 | EventBus.addEventListener('my_function_event', myFunction);
7 | EventBus.dispatch('my_function_event');


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "eventbusjs",
 3 |   "version": "0.2.0",
 4 |   "description": "Managing events with JavaScript",
 5 |   "main": "lib/eventbus.min.js",
 6 |   "directories": {
 7 |     "example": "example"
 8 |   },
 9 |   "scripts": {
10 |     "build": "uglifyjs ./src/EventBus.js -o ./lib/eventbus.min.js"
11 |   },
12 |   "repository": {
13 |     "type": "git",
14 |     "url": "https://github.com/krasimir/EventBus.git"
15 |   },
16 |   "keywords": [
17 |     "event",
18 |     "bus",
19 |     "dispatch",
20 |     "listen"
21 |   ],
22 |   "author": "Krasimir Tsonev",
23 |   "license": "MIT",
24 |   "bugs": {
25 |     "url": "https://github.com/krasimir/EventBus/issues"
26 |   },
27 |   "homepage": "https://github.com/krasimir/EventBus",
28 |   "devDependencies": {
29 |     "uglify-js": "2.6.2"
30 |   }
31 | }
32 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2014 Krasimir Tsonev
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of
 6 | this software and associated documentation files (the "Software"), to deal in
 7 | the Software without restriction, including without limitation the rights to
 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 9 | the Software, and to permit persons to whom the Software is furnished to do so,
10 | subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


--------------------------------------------------------------------------------
/lib/eventbus.min.js:
--------------------------------------------------------------------------------
1 | (function(root,factory){if(typeof exports==="object"&&typeof module==="object")module.exports=factory();else if(typeof define==="function"&&define.amd)define("EventBus",[],factory);else if(typeof exports==="object")exports["EventBus"]=factory();else root["EventBus"]=factory()})(this,function(){var EventBusClass={};EventBusClass=function(){this.listeners={}};EventBusClass.prototype={addEventListener:function(type,callback,scope){var args=[];var numOfArgs=arguments.length;for(var i=0;i<numOfArgs;i++){args.push(arguments[i])}args=args.length>3?args.splice(3,args.length-1):[];if(typeof this.listeners[type]!="undefined"){this.listeners[type].push({scope:scope,callback:callback,args:args})}else{this.listeners[type]=[{scope:scope,callback:callback,args:args}]}},removeEventListener:function(type,callback,scope){if(typeof this.listeners[type]!="undefined"){var numOfCallbacks=this.listeners[type].length;var newArray=[];for(var i=0;i<numOfCallbacks;i++){var listener=this.listeners[type][i];if(listener.scope==scope&&listener.callback==callback){}else{newArray.push(listener)}}this.listeners[type]=newArray}},hasEventListener:function(type,callback,scope){if(typeof this.listeners[type]!="undefined"){var numOfCallbacks=this.listeners[type].length;if(callback===undefined&&scope===undefined){return numOfCallbacks>0}for(var i=0;i<numOfCallbacks;i++){var listener=this.listeners[type][i];if((scope?listener.scope==scope:true)&&listener.callback==callback){return true}}}return false},dispatch:function(type,target){var event={type:type,target:target};var args=[];var numOfArgs=arguments.length;for(var i=0;i<numOfArgs;i++){args.push(arguments[i])}args=args.length>2?args.splice(2,args.length-1):[];args=[event].concat(args);if(typeof this.listeners[type]!="undefined"){var listeners=this.listeners[type].slice();var numOfCallbacks=listeners.length;for(var i=0;i<numOfCallbacks;i++){var listener=listeners[i];if(listener&&listener.callback){var concatArgs=args.concat(listener.args);listener.callback.apply(listener.scope,concatArgs)}}}},getEvents:function(){var str="";for(var type in this.listeners){var numOfCallbacks=this.listeners[type].length;for(var i=0;i<numOfCallbacks;i++){var listener=this.listeners[type][i];str+=listener.scope&&listener.scope.className?listener.scope.className:"anonymous";str+=" listen for '"+type+"'\n"}}return str}};var EventBus=new EventBusClass;return EventBus});


--------------------------------------------------------------------------------
/example/browser/example.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 2 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 3 | 	<head>
 4 | 		<title>Events</title>
 5 | 
 6 | 		<script type="text/javascript" language="javascript" src="../../lib/eventbus.min.js"></script>
 7 | 		<script type="text/javascript" language="javascript">
 8 | 
 9 | 			window.onload = function() {
10 | 
11 | 				// ******************************************************************************************
12 | 				function myFunction(event) {
13 | 					console.log("myFunction type=" + event.type);
14 | 				}
15 | 				EventBus.addEventListener("my_function_event", myFunction);
16 | 				EventBus.dispatch("my_function_event");
17 | 
18 | 				// ******************************************************************************************
19 | 				console.log("\n");
20 | 				var TestClass1 = function() {
21 | 					this.className = "TestClass1";
22 | 					this.callback = function(event) {
23 | 						console.log(this.className + " = type:" + event.type + " / dispatcher:" + event.target.className);
24 | 					}
25 | 				};
26 | 				var TestClass2 = function() {
27 | 					this.className = "TestClass2";
28 | 					this.dispatchOurEvent = function() {
29 | 						EventBus.dispatch("callback_event", this);
30 | 					}
31 | 				};
32 | 				var t1 = new TestClass1();
33 | 				var t2 = new TestClass2();
34 | 				EventBus.addEventListener("callback_event", t1.callback, t1);
35 | 				t2.dispatchOurEvent();
36 | 
37 | 				// ******************************************************************************************
38 | 				console.log("\n");
39 | 				var TestClass1 = function() {
40 | 					this.className = "TestClass1";
41 | 					this.doSomething = function(event, param1, param2) {
42 | 						console.log(this.className + ".doSomething");
43 | 						console.log("type=" + event.type);
44 | 						console.log("params=" + param1 + param2);
45 | 						console.log("coming from=" + event.target.className);
46 | 					}
47 | 				};
48 | 				var TestClass2 = function() {
49 | 					this.className = "TestClass2";
50 | 					this.ready = function() {
51 | 						EventBus.dispatch("custom_event", this, "javascript events", " are really useful");
52 | 					}
53 | 				};
54 | 
55 | 				var t1 = new TestClass1();
56 | 				var t2 = new TestClass2();
57 | 
58 | 				EventBus.addEventListener("custom_event", t1.doSomething, t1);
59 | 				t2.ready();
60 | 
61 | 				// ******************************************************************************************
62 | 				console.log("\n");
63 | 				var winterHandler = function() {
64 | 					console.log("arguments", arguments);
65 | 				}
66 | 				EventBus.addEventListener("let-it-snow", winterHandler, null, "and happy", "new year");
67 | 				EventBus.dispatch("let-it-snow", null, "merry", "christmas");
68 | 				EventBus.dispatch("let-it-snow", null, "merry", "christmas");
69 | 				EventBus.dispatch("let-it-snow", null, "merry", "christmas");
70 | 
71 | 			}
72 | 
73 | 		</script>
74 | 
75 | 	</head>
76 | 	<body>
77 | 		<div id="console.log">
78 | 
79 | 		</div>
80 | 	</body>
81 | </html>


--------------------------------------------------------------------------------
/src/EventBus.js:
--------------------------------------------------------------------------------
  1 | (function (root, factory) {
  2 | 	if(typeof exports === 'object' && typeof module === 'object')
  3 | 		module.exports = factory();
  4 | 	else if(typeof define === 'function' && define.amd)
  5 | 		define("EventBus", [], factory);
  6 | 	else if(typeof exports === 'object')
  7 | 		exports["EventBus"] = factory();
  8 | 	else
  9 | 		root["EventBus"] = factory();
 10 | })(this, function() {
 11 | 
 12 | 	var EventBusClass = {};
 13 | 	EventBusClass = function() {
 14 | 		this.listeners = {};
 15 | 	};
 16 | 	EventBusClass.prototype = {
 17 | 		addEventListener: function(type, callback, scope) {
 18 | 			var args = [];
 19 | 			var numOfArgs = arguments.length;
 20 | 			for(var i=0; i<numOfArgs; i++){
 21 | 				args.push(arguments[i]);
 22 | 			}
 23 | 			args = args.length > 3 ? args.splice(3, args.length-1) : [];
 24 | 			if(typeof this.listeners[type] != "undefined") {
 25 | 				this.listeners[type].push({scope:scope, callback:callback, args:args});
 26 | 			} else {
 27 | 				this.listeners[type] = [{scope:scope, callback:callback, args:args}];
 28 | 			}
 29 | 		},
 30 | 		removeEventListener: function(type, callback, scope) {
 31 | 			if(typeof this.listeners[type] != "undefined") {
 32 | 				var numOfCallbacks = this.listeners[type].length;
 33 | 				var newArray = [];
 34 | 				for(var i=0; i<numOfCallbacks; i++) {
 35 | 					var listener = this.listeners[type][i];
 36 | 					if(listener.scope == scope && listener.callback == callback) {
 37 | 
 38 | 					} else {
 39 | 						newArray.push(listener);
 40 | 					}
 41 | 				}
 42 | 				this.listeners[type] = newArray;
 43 | 			}
 44 | 		},
 45 | 		hasEventListener: function(type, callback, scope) {
 46 | 			if(typeof this.listeners[type] != "undefined") {
 47 | 				var numOfCallbacks = this.listeners[type].length;
 48 | 				if(callback === undefined && scope === undefined){
 49 | 					return numOfCallbacks > 0;
 50 | 				}
 51 | 				for(var i=0; i<numOfCallbacks; i++) {
 52 | 					var listener = this.listeners[type][i];
 53 | 					if((scope ? listener.scope == scope : true) && listener.callback == callback) {
 54 | 						return true;
 55 | 					}
 56 | 				}
 57 | 			}
 58 | 			return false;
 59 | 		},
 60 | 		dispatch: function(type, target) {
 61 | 			var event = {
 62 | 				type: type,
 63 | 				target: target
 64 | 			};
 65 | 			var args = [];
 66 | 			var numOfArgs = arguments.length;
 67 | 			for(var i=0; i<numOfArgs; i++){
 68 | 				args.push(arguments[i]);
 69 | 			};
 70 | 			args = args.length > 2 ? args.splice(2, args.length-1) : [];
 71 | 			args = [event].concat(args);
 72 | 
 73 | 
 74 | 			if(typeof this.listeners[type] != "undefined") {
 75 | 				var listeners = this.listeners[type].slice();
 76 | 				var numOfCallbacks = listeners.length;
 77 | 				for(var i=0; i<numOfCallbacks; i++) {
 78 | 					var listener = listeners[i];
 79 | 					if(listener && listener.callback) {
 80 | 						var concatArgs = args.concat(listener.args);
 81 | 						listener.callback.apply(listener.scope, concatArgs);
 82 | 					}
 83 | 				}
 84 | 			}
 85 | 		},
 86 | 		getEvents: function() {
 87 | 			var str = "";
 88 | 			for(var type in this.listeners) {
 89 | 				var numOfCallbacks = this.listeners[type].length;
 90 | 				for(var i=0; i<numOfCallbacks; i++) {
 91 | 					var listener = this.listeners[type][i];
 92 | 					str += listener.scope && listener.scope.className ? listener.scope.className : "anonymous";
 93 | 					str += " listen for '" + type + "'\n";
 94 | 				}
 95 | 			}
 96 | 			return str;
 97 | 		}
 98 | 	};
 99 | 	var EventBus = new EventBusClass();
100 | 	return EventBus;
101 | });
102 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # Simple JavaScript class for managing events in JavaScript
  2 | 
  3 | ## Installation
  4 | 
  5 | ### In a browser
  6 | 
  7 | Download [eventbus.min.js](https://raw.githubusercontent.com/krasimir/EventBus/master/lib/eventbus.min.js) and add it to your page.
  8 | 
  9 | ### In Node
 10 | 
 11 | ```
 12 | npm i eventbusjs -S
 13 | ```
 14 | 
 15 | And then in your code:
 16 | 
 17 | ```js
 18 | var EventBus = require('eventbusjs');
 19 | ```
 20 | 
 21 | ## API
 22 | 
 23 | ### `addEventListener`
 24 | 
 25 | ```js
 26 | // @type - string
 27 | // @callback - function
 28 | // @scope - the scope where the @callback is defined
 29 | EventBus.addEventListener(type, callback, scope)
 30 | ```
 31 | 
 32 | ### `removeEventListener`
 33 | 
 34 | ```js
 35 | // @type - string
 36 | // @callback - function
 37 | // @scope - the scope where the @callback is defined
 38 | EventBus.removeEventListener(type, callback, scope)
 39 | ```
 40 | 
 41 | ### `hasEventListener`
 42 | 
 43 | ```js
 44 | // @type - string
 45 | // @callback - function
 46 | // @scope - the scope where the @callback is defined
 47 | EventBus.hasEventListener(type, callback, scope)
 48 | ```
 49 | 
 50 | ### `dispatch`
 51 | 
 52 | ```js
 53 | // @type - string
 54 | // @target - the caller
 55 | // @args - pass as many arguments as you want
 56 | EventBus.dispatch(type, target, args ...)
 57 | ```
 58 | 
 59 | ### `getEvents`
 60 | 
 61 | For debugging purpose, it prints out the added listeners.
 62 | 
 63 | ```js
 64 | EventBus.getEvents()
 65 | ```
 66 | 
 67 | ## Usage
 68 | 
 69 | ```js
 70 | function myFunction(event) {
 71 |   console.log("myFunction type=" + event.type);
 72 | }
 73 | EventBus.addEventListener("my_function_event", myFunction);
 74 | EventBus.dispatch("my_function_event");
 75 | ```
 76 | 
 77 | ## Keeping the scope
 78 | 
 79 | ```js
 80 | var TestClass1 = function() {
 81 |   this.className = "TestClass1";
 82 |   this.callback = function(event) {
 83 |     console.log(this.className + " = type:" + event.type + " / dispatcher:" + event.target.className);
 84 |   }
 85 | };
 86 | var TestClass2 = function() {
 87 |   this.className = "TestClass2";
 88 |   this.dispatchOurEvent = function() {
 89 |     EventBus.dispatch("callback_event", this);
 90 |   }
 91 | };
 92 | var t1 = new TestClass1();
 93 | var t2 = new TestClass2();
 94 | EventBus.addEventListener("callback_event", t1.callback, t1);
 95 | t2.dispatchOurEvent();
 96 | ```
 97 | 
 98 | ## Passing additional parameters
 99 | 
100 | ```js
101 | var TestClass1 = function() {
102 |   this.className = "TestClass1";
103 |   this.doSomething = function(event, param1, param2) {
104 |     console.log(this.className + ".doSomething");
105 |     console.log("type=" + event.type);
106 |     console.log("params=" + param1 + param2);
107 |     console.log("coming from=" + event.target.className);
108 |   }
109 | };
110 | var TestClass2 = function() {
111 |   this.className = "TestClass2";
112 |   this.ready = function() {
113 |     EventBus.dispatch("custom_event", this, "javascript events", " are really useful");
114 |   }
115 | };
116 | 
117 | var t1 = new TestClass1();
118 | var t2 = new TestClass2();
119 | 
120 | EventBus.addEventListener("custom_event", t1.doSomething, t1);
121 | t2.ready();
122 | ```
123 | 
124 | ## Example of usage EventBus.removeEventListener
125 | 
126 | To remove EventListener you have to pass same instance of callback
127 | ```js
128 | 
129 | /* Wrong - callback functions are different instances */
130 | EventBus.addEventListener('EXAMPLE_EVENT', function() {
131 |     console.log('example callback');
132 | });
133 | EventBus.removeEventListener('EXAMPLE_EVENT', function() {
134 |     console.log('example callback');
135 | });
136 | 
137 | /* Correct - callback function is the same instance */
138 | var handler = function() {
139 |     console.log('example callback');
140 | };
141 | EventBus.addEventListener('EXAMPLE_EVENT', handler);
142 | EventBus.removeEventListener('EXAMPLE_EVENT', handler);
143 | ```
144 | 


--------------------------------------------------------------------------------