@peter.naydenov/notice 1.0.2 → 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Peter Naydenov
+
+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.

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'
 }
 ```
 
@@ -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' )
@@ -155,24 +156,59 @@ Enable again specified event.
 
 ```js
 let result = 0;
-const 
-      eBus = notice ()
-    , fn1 = x => result += 1 + x
-    , fn2 = x => result += 3 + x
-    ;
- eBus.on ( 'go', fn1 )
- eBus.on ( 'go', fn2 )
- eBus.stop ( 'go' )
- eBus.emit ( 'go', 2 )
-// ---> result == 0
- eBus.start ( 'go', 2 )
- eBus.emit ( 'go' )
- // ---> result == 8
+    const 
+          eBus = notice ()
+        , fn1 = x => result += 1 + x
+        , fn2 = x => result += 3 + x
+        ;
+     eBus.on ( 'go', fn1 )
+     eBus.on ( 'go', fn2 )
+     eBus.stop ( 'go' )
+     eBus.emit ( 'go', 2 )
+    // ---> result == 0
+     eBus.start ( 'go' )
+     eBus.emit ( 'go', 1 )
+     console.log ( result )
+     // ---> result == 6 
 ```
 
 
+### 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
 
+
+
+### 2.0.0 ( 2023-06-15)
+- [x] Library was converted to ES6 module;
+- [x] License was changed from ISC to MIT;
+
+
+
+### 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,11 +1,12 @@
 {
   "name": "@peter.naydenov/notice",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "description": "Event emmiter - NOTICE",
   "main": "src/main.js",
+  "type": "module",
   "scripts": {
     "test": "mocha test",
-    "cover": "nyc mocha"
+    "cover": "c8 mocha"
   },
   "author": "Peter Naydenov",
   "keywords": [
@@ -15,13 +16,13 @@
     "subscriber",
     "pubsub"
   ],
-  "license": "ISC",
+  "license": "MIT",
   "devDependencies": {
-    "chai": "4.3.6",
-    "mocha": "10.0.0",
-    "nyc": "15.1.0"
+    "c8": "^8.0.0",
+    "chai": "4.3.7",
+    "mocha": "10.2.0"
   },
-  "nyc": {
+  "c8": {
     "include": [
       "src/**/*.js"
     ],

package/src/main.js

@@ -5,6 +5,8 @@ function notice () {
                           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] = []
@@ -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 ()
@@ -77,6 +93,6 @@ function notice () {
 
 
 
-module.exports = notice
+export default notice
 
 

package/test/01-notice.js

@@ -1,12 +1,16 @@
 "use strict"
 
-const 
-      notice = require ( '../src/main' )
-    , expect = require ( 'chai' ).expect
-    ;
+import notice from '../src/main.js'
+import { expect } from 'chai'
+
+
+
+
 
 describe ( 'Testing Notice', () => {
 
+
+
 it ( 'Standard event', () => {
     const eBus = notice ();
     let result = 0;
@@ -258,6 +262,7 @@ it ( 'Multiple Notice instances', () => {
 }) // it Multiple Notice instances
 
 
+
 }) // define