@peter.naydenov/notice 2.2.2 → 2.3.0

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. What is environment  'browser/node/version...'. Describe it best is possible
+2. Settings applied to the library...
+3. Call with data ...
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Description of the result**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+peter.naydenov@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/Changelog.md

@@ -1,6 +1,15 @@
 # Release History
 
 
+### 2.3.0 ( 2024-03-14 )
+- [x] Stop execution of the event callbacks on first callback that returns string 'stop';
+
+
+
+### 2.2.3 ( 2024-01-29)
+- [x] Folder 'dist' was added. It contains compiled files for commonjs and es6 modules;
+- [x] Package.json: "exports" section was added. Allows you to use package as commonjs or es6 module without additional configuration;
+
 
 
 ### 2.2.2 ( 2023-11-09)
@@ -11,6 +20,8 @@
 ### 2.2.1 ( 2023-10-23)
 - [x] Fix: Calling 'Reset' breaks callback execution;
 
+
+
 ### 2.2.0 ( 2023-09-20)
 - [x] Listen with wildcard was added;
 - [ ] Bug: Calling 'Reset' breaks callback execution;

package/README.md

@@ -6,13 +6,24 @@
 
 # Notice (@peter.naydenov/notice)
 
-![version](https://img.shields.io/github/package-json/v/peterNaydenov/notice)
-![license](https://img.shields.io/github/license/peterNaydenov/notice)
-![issues](https://img.shields.io/github/issues/peterNaydenov/notice)
-![npm package minimized gzipped size (scoped version select exports)](https://img.shields.io/bundlejs/size/%40peter.naydenov/notice)
+![Version](https://img.shields.io/github/package-json/v/peterNaydenov/notice)
+![License](https://img.shields.io/github/license/peterNaydenov/notice)
+![Issues](https://img.shields.io/github/issues/peterNaydenov/notice)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40peter.naydenov%2Fnotice)
+
+
+`Notice` is an simple event emitter. Define a behaviour related to event and then trigger the event.  
+Register multiple callbacks to the same event. Order of execution is the same as the order of registration.
+Use method '**stop**' to mute the event for a while. Use method '**start**' to unmute the event. Method '**off**' will remove the event and all related callbacks. Method 'reset' will remove all events and functions from the event emitter.
+
+
+
+## Last Updates
+- After version 2.1.0  Method 'reset' was added. It removes all events and functions from the event emitter;
+- After version 2.3.0  If callback that returns a string 'stop', the execution of followed callbacks will be stopped. Use this functionality to create a condition checking functions before  your main callback if needed;
+
 
 
-Notice is an simple event emitter. Define a behaviour related to event and then trigger the event. 
 
 ## Installation
 Write in your project
@@ -28,12 +39,53 @@ npm install @peter.naydenov/notice
 ## How to use it
 Here is simple example for using this trivial event emitter:
 ```js
+// with ES6 modules:
 import notice from '@peter.naydenov/notice'
+// with CommonJS:
+// const notice = require('@peter.naydenov/notice')
 const eBus   = notice ();
 
 eBus.on ( 'note' , () => console.log ( 'hey!')   )
 eBus.emit ( 'note' )
 // ---> 'hey!'
+
+// example 2
+eBus.on ( 'note' , () => console.log ( 'hey!')   )
+eBus.on ( 'note' , () => console.log ( 'ho!')   )
+eBus.emit ( 'note' )   // will execute all functions related to the event
+// ---> 'hey!ho!'
+
+// example 3
+eBus.on ( 'note' , () => console.log ( 'hey!')   )
+eBus.on ( 'note' , () => console.log ( 'ho!')   )
+eBus.off ( 'note' )   // will remove all functions related to the event
+eBus.emit ( 'note' )   // nothing will happen
+
+// example 4
+let x = 0;
+eBus.on ( 'note' , () => { 
+                        console.log ( 'hey!')
+                        if ( x === 0 ) {
+                                x++
+                                return 'stop'
+                            }
+                })
+eBus.on ( 'note' , () => {
+                        console.log ( 'ho!')
+                        x++
+                  })
+eBus.emit ( 'note' )   // Will execute only the first function. If callback returns 'stop', the execution of callbacks will be stopped.
+// ---> 'hey!'
+// x == 1
+
+
+
+// example 5
+eBus.on ( 'note' , () => console.log ( 'hey!')   )
+eBus.stop ( 'note' )   // will mute the event
+eBus.emit ( 'note' )   // nothing will happen
+eBus.start ( 'note' )  // will unmute the event
+eBus.emit ( 'note' )   // ---> 'hey!'
 ```
 
 
@@ -238,4 +290,4 @@ eBus.emit ( 'dummy' )
 
 
 ## License
-'notice' is released under the [ISC License](https://opensource.org/licenses/ISC).
+'notice' is released under the [MIT License](https://opensource.org/licenses/ISC).

package/SECURITY.md

@@ -0,0 +1,18 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 2.x.x   | :white_check_mark: |
+| < 2.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Security vulnerabilities should be reported as a 'issue' on the github repository. Please include the following information:
+- A description of the vulnerability
+- Steps to reproduce the vulnerability
+- Versions affected

package/coverage/lcov-report/index.html

@@ -23,30 +23,30 @@
         <div class='clearfix'>
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">90.19% </span>
+                <span class="strong">90.26% </span>
                 <span class="quiet">Statements</span>
-                <span class='fraction'>92/102</span>
+                <span class='fraction'>102/113</span>
             </div>
         
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">97.77% </span>
+                <span class="strong">94.11% </span>
                 <span class="quiet">Branches</span>
-                <span class='fraction'>44/45</span>
+                <span class='fraction'>48/51</span>
             </div>
         
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">90% </span>
+                <span class="strong">90.9% </span>
                 <span class="quiet">Functions</span>
-                <span class='fraction'>9/10</span>
+                <span class='fraction'>10/11</span>
             </div>
         
             
             <div class='fl pad1y space-right2'>
-                <span class="strong">90.19% </span>
+                <span class="strong">90.26% </span>
                 <span class="quiet">Lines</span>
-                <span class='fraction'>92/102</span>
+                <span class='fraction'>102/113</span>
             </div>
         
             
@@ -80,17 +80,17 @@
 </thead>
 <tbody><tr>
 	<td class="file high" data-value="main.js"><a href="main.js.html">main.js</a></td>
-	<td data-value="90.19" class="pic high">
+	<td data-value="90.26" class="pic high">
 	<div class="chart"><div class="cover-fill" style="width: 90%"></div><div class="cover-empty" style="width: 10%"></div></div>
 	</td>
-	<td data-value="90.19" class="pct high">90.19%</td>
-	<td data-value="102" class="abs high">92/102</td>
-	<td data-value="97.77" class="pct high">97.77%</td>
-	<td data-value="45" class="abs high">44/45</td>
-	<td data-value="90" class="pct high">90%</td>
-	<td data-value="10" class="abs high">9/10</td>
-	<td data-value="90.19" class="pct high">90.19%</td>
-	<td data-value="102" class="abs high">92/102</td>
+	<td data-value="90.26" class="pct high">90.26%</td>
+	<td data-value="113" class="abs high">102/113</td>
+	<td data-value="94.11" class="pct high">94.11%</td>
+	<td data-value="51" class="abs high">48/51</td>
+	<td data-value="90.9" class="pct high">90.9%</td>
+	<td data-value="11" class="abs high">10/11</td>
+	<td data-value="90.26" class="pct high">90.26%</td>
+	<td data-value="113" class="abs high">102/113</td>
 	</tr>
 
 </tbody>
@@ -101,7 +101,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2023-08-04T17:12:38.948Z
+                at 2024-03-14T06:34:16.346Z
             </div>
         <script src="prettify.js"></script>
         <script>