@yhwh-script/event-bux 1.0.3 → 1.0.4

package/README.md

@@ -19,7 +19,7 @@ classDiagram
 
 ## How-To
 
-After importing this module in your code, it is recommended to add it to the window object:
+For instance: 
 
 ```javascript
 <script type="module">
@@ -27,4 +27,15 @@ After importing this module in your code, it is recommended to add it to the win
   window.bus = bus;
 </script>
 ```
-Then use `bus.addEventListener(type, listener)` and `bus.dispatchEvent(type, event)` to send event between components.
+
+After importing `@yhwh-script/event-bux`, it is recommended to add it to the `window` object.
+
+You can use your own import or stick to other `@yhwh-script` examples
+
+Then use `bus.addEventListener(type, listener)` and `bus.dispatchEvent(type, event)` in your WebComponents. You are not bound to event bubbling or capturing (which are the standard event propagation mechanisms), but you can send events even between WebComponents! Check it out!
+
+![EventBus schema](eventbus.png)
+
+## Contribute
+
+Welcome!

package/index.js

@@ -1,7 +1,8 @@
+export const name = "eventbux"; // The module name, can be made globally available via the window object, which should be on top.
 const listeners = new WeakMap(); // WeakMap to store listeners per object. Keep it private unless you know what you do.
-// Should auto-cleanup listeners when object is GC'd
-// implements EventTarget
-export const addEventListener = function (type, listener, context = undefined) {
+// Should auto-cleanup listeners when object is GC'd (TODO Test!)
+// This module implements EventTarget.
+export const addEventListener = function (type, listener, context = undefined) { // (TODO check integration into options)
     if (context && typeof context === 'object') { // context is well defined, should be a WebComponent
         if (!listeners.has(context)) { // context is yet unknown to the listeners
             listeners.set(context, new Map()); // will be stored here
@@ -12,8 +13,8 @@ export const addEventListener = function (type, listener, context = undefined) {
         } // next push the handler to the WeakMap for the given context
         contextListeners.get(eventName).push(listener);
     } else { // default
-        if (context) {
-            throw new Error("Syntax error.") // illegal context
+        if (context) { // illegal context
+            throw new Error("Syntax error.")
         }
         window.addEventListener(type, listener);
     }
@@ -34,7 +35,7 @@ export const removeEventListener = function (type, listener, context = undefined
     }
 }
 
-export const dispatchEvent = function (event, context = undefined) {
+export const dispatchEvent = function (event, context = undefined) { // TODO check if context == event.target, if yes, remove context? What if CustomEvent is used?
     if (context && listeners.has(context)) {
         const contextListeners = listeners.get(context);
         if (contextListeners.has(event.type)) { // Call context-specific listeners

package/package.json

@@ -22,5 +22,5 @@
         "url": "git+https://github.com/yhwh-script/event-bux.git"
     },
     "type": "module",
-    "version": "1.0.3"
+    "version": "1.0.4"
 }