@peter.naydenov/notice 1.0.1 → 1.1.0

package/README.md

@@ -38,6 +38,7 @@ eBus.emit ( 'note' )
     , emit  : 'Trigger a event'
     , stop  : 'Ignore event for a while'
     , start : 'Remove event from ignore list'
+    , debug : 'Returns a console message on each triggered event'
 }
 ```
 
@@ -48,7 +49,7 @@ Register a regular event.
 ```js
   const eBus = notice ();
 
-  eBus.on ( 'start', ([name]) => console.log ( `Hey, ${name}!` )   )   // notice that data params from emit are coming as array
+  eBus.on ( 'start', name => console.log ( `Hey, ${name}!` )   )   
   eBus.emit ( 'start', 'Johny' )
 // ---> Hey, Johny!
   eBus.emit ( 'start', 'Vessy' )
@@ -64,7 +65,7 @@ Register a single event.
 ```js
 const eBus = notice ();
 
-eBus.once ( 'start', ([name]) => console.log ( `Hey, ${name}!` )   )   // notice that data params from emit is coming as array
+eBus.once ( 'start', name => console.log ( `Hey, ${name}!` )   )
 eBus.emit ( 'start', 'Johny' )
 // ---> Hey, Johny!
 eBus.emit ( 'start', 'Vessy' )
@@ -114,8 +115,8 @@ Trigger the event and execute all subscribed functions.
 let result = 0;
 const 
       eBus = notice ()
-    , fn1 = ([x]) => result += 1 + x
-    , fn2 = ([x]) => result += 3 + x
+    , fn1 = x => result += 1 + x
+    , fn2 = x => result += 3 + x
     ;
  eBus.on ( 'go', fn1 )
  eBus.on ( 'go', fn2 )
@@ -135,8 +136,8 @@ Disable specified event.
 let result = 0;
 const 
       eBus = notice ()
-    , fn1 = ([x]) => result += 1 + x
-    , fn2 = ([x]) => result += 3 + x
+    , fn1 = x => result += 1 + x
+    , fn2 = x => result += 3 + x
     ;
  eBus.on ( 'go', fn1 )
  eBus.on ( 'go', fn2 )
@@ -157,8 +158,8 @@ Enable again specified event.
 let result = 0;
 const 
       eBus = notice ()
-    , fn1 = ([x]) => result += 1 + x
-    , fn2 = ([x]) => result += 3 + x
+    , fn1 = x => result += 1 + x
+    , fn2 = x => result += 3 + x
     ;
  eBus.on ( 'go', fn1 )
  eBus.on ( 'go', fn2 )
@@ -171,8 +172,28 @@ const
 ```
 
 
+### Notice.debug ( state, label )
+Provide debug message on each event. By default is debug is 'off'.
+
+```js
+// Turn debug "on"
+eBus.debug ( true )
+
+// Turn debug "off"
+eBus.debug ( false )
+
+// Activate debugger and set a debug message prefix
+eBus.debug ( true, '[eBus]:' )
+eBus.emit ( 'dummy' )
+// --> [eBus]: Event "dummy" was triggered.
+```
+
+
 ## Release History
 
+### 1.1.0 ( 2022-10-21)
+- [x] Method 'debug' was added;
+
 ### 1.0.1 ( 2022-08-15)
 - [x] Fix: Event data is coming in Array;
 - [x] Fix: Multiple instances of notice;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peter.naydenov/notice",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Event emmiter - NOTICE",
   "main": "src/main.js",
   "scripts": {
@@ -18,7 +18,7 @@
   "license": "ISC",
   "devDependencies": {
     "chai": "4.3.6",
-    "mocha": "9.2.1",
+    "mocha": "10.0.0",
     "nyc": "15.1.0"
   },
   "nyc": {

package/src/main.js

@@ -1,11 +1,13 @@
 "use strict"
 function notice () {
-    let 
-          scroll     = {}  // General events with their subscribers
-        , scrollOnce = {}  // Single events with their subscribers
-        , ignore     = []  // Ignore event names ( general and single )
-        ;
     function Notice () {
+                    let 
+                          scroll     = {}  // General events with their subscribers
+                        , scrollOnce = {}  // Single events with their subscribers
+                        , ignore     = []  // Ignore event names ( general and single )
+                        , debugFlag  = false 
+                        , debugHeader = ''
+                        ;
                     function on ( e, fn ) {
                             if ( !scroll[e] ) scroll[e] = []
                             scroll[e].push ( fn )
@@ -15,7 +17,7 @@ function notice () {
                             scrollOnce[e].push ( fn )
                         } // once func.
                     function off ( e, fx ) {
-                            if ( fx ) {   // fx is optional
+                            if ( fx ) {   // fx is optional
                                     if ( scroll[e]     )  scroll[e]     = scroll[e].filter     ( fn => fn !== fx )
                                     if ( scrollOnce[e] )  scrollOnce[e] = scrollOnce[e].filter ( fn => fn !== fx )
                                     if ( scroll[e] && scroll[e].length         === 0 )   delete scroll[e]
@@ -25,8 +27,21 @@ function notice () {
                             if ( scrollOnce[e] )   delete scrollOnce[e]
                             if ( scroll[e]     )   delete scroll[e]
                         } // off func.
+                    function debug ( val, header ) {
+                            debugFlag =  val ? true : false
+                            if ( header && (typeof header === 'string') )   debugHeader = header
+                        } // debug func.
                     function emit () {
                             const [ e, ...args ] = arguments
+                            if ( debugFlag ) {  
+                                        console.log ( `${debugHeader} Event "${e}" was triggered.`)
+                                        if ( args.length > 0 ) {
+                                            console.log ( 'Arguments:')
+                                            console.log ( ...args )
+                                            console.log ( '^----' )
+                                        }
+                                        
+                                }
                             if ( e == '*' ) {   // The wildcard '*' doesn't work for 'once' events
                                     let evNames = Object.keys ( scroll )
                                     evNames.forEach ( name => {
@@ -70,6 +85,7 @@ function notice () {
                                 , emit  // Trigger a event
                                 , stop  // Ignore event for a while
                                 , start // Remove event from ignore list
+                                , debug
                         }
         } // notice fn.
     return new Notice ()