@peter.naydenov/notice 1.1.0 → 2.1.0

package/Changelog.md

@@ -0,0 +1,34 @@
+# Release History
+
+
+### 2.1.0 ( 2023-07-17)
+- [x] Method 'reset' was added. It removes all events and functions from the event emitter; 
+
+
+
+### 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;
+
+
+
+### 1.0.0 (2021-05-12)
+- [x] Initial code;
+- [x] Test package;
+- [x] Documentation;
+- [ ] Bug: Event data is coming in Array;
+- [ ] Bug: Multiple instances of notice;
+
+

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

@@ -35,6 +35,7 @@ eBus.emit ( 'note' )
       on    : 'Register a event'
     , once  : 'Register a single event'
     , off   : 'Unregister regular and single events'
+    , reset : 'Remove all events and functions from the event emitter' // After version 2.1.0
     , emit  : 'Trigger a event'
     , stop  : 'Ignore event for a while'
     , start : 'Remove event from ignore list'
@@ -103,7 +104,25 @@ const
  // ---> result == 5. Nothing changed
 ```
 
+### Notice.reset ( )
+Will remove all events and functions from the event emitter.
+```js
+let result = 0;
+const 
+      eBus = notice ()
+    , fn1 = () => result += 1
+    , fn2 = () => result += 3
+    , fn3 = () => result += 20
+    ;
 
+ eBus.on ( 'go', fn1 )
+ eBus.on ( 'go', fn2 )
+ eBus.on ( 'load', fn3 )
+ eBus.reset () // Remove all events and functions
+ eBus.emit ( 'go' )
+ eBus.emit ( 'load' )
+// ---> result == 0
+```
 
 
 ### Notice.emit ( eventName, data )
@@ -156,19 +175,20 @@ 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 
 ```
 
 
@@ -189,25 +209,11 @@ eBus.emit ( 'dummy' )
 ```
 
 
-## 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;
-
-
-
-### 1.0.0 (2021-05-12)
-- [x] Initial code;
-- [x] Test package;
-- [x] Documentation;
-- [ ] Bug: Event data is coming in Array;
-- [ ] Bug: Multiple instances of notice;
 
+## External Links
 
+- [History of changes](https://github.com/PeterNaydenov/notice/Changelog.md)
+- [MIT License](https://github.com/PeterNaydenov/notice/LICENSE)
 
 
 

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "@peter.naydenov/notice",
-  "version": "1.1.0",
+  "version": "2.1.0",
   "description": "Event emmiter - NOTICE",
   "main": "src/main.js",
+  "type": "module",
   "scripts": {
     "test": "mocha test",
-    "cover": "nyc mocha"
+    "cover": "c8 mocha"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PeterNaydenov/notice"
   },
   "author": "Peter Naydenov",
   "keywords": [
@@ -15,13 +20,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

@@ -27,6 +27,11 @@ function notice () {
                             if ( scrollOnce[e] )   delete scrollOnce[e]
                             if ( scroll[e]     )   delete scroll[e]
                         } // off func.
+                    function reset () {
+                            scroll     = {}
+                            scrollOnce = {}
+                            ignore     = []
+                        } // reset func.
                     function debug ( val, header ) {
                             debugFlag =  val ? true : false
                             if ( header && (typeof header === 'string') )   debugHeader = header
@@ -82,6 +87,7 @@ function notice () {
                                   on    // Register a event
                                 , once  // Register a single event 
                                 , off   // Unregister regular and single events
+                                , reset // Unregister all events
                                 , emit  // Trigger a event
                                 , stop  // Ignore event for a while
                                 , start // Remove event from ignore list
@@ -93,6 +99,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;
@@ -65,6 +69,20 @@ it ( 'Remove single event', () => {
 
 
 
+it ( 'Reset the emitter', () => {
+    const eBus = notice ();
+    let result = 0;
+
+    eBus.once ( 'note', () => result += 1 )
+    eBus.on   ( 'note', () => result += 3 )
+    eBus.on   ( 'boom', () => result += 9 )
+    eBus.reset ()
+    eBus.emit ( 'note' )
+    eBus.emit ( 'boom' )
+    expect ( result ).to.be.equal ( 0 )
+}) // it reset the emitter
+
+
 it ( 'Stop and resume standard event', () => {
     const eBus = notice ();
     let result = 0;
@@ -258,6 +276,7 @@ it ( 'Multiple Notice instances', () => {
 }) // it Multiple Notice instances
 
 
+
 }) // define