npm - events-ex - Versions diffs - 2.3.0 → 2.4.0 - Mend

events-ex 2.3.0 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (122) hide show

package/.babelrc +1 -1
package/CHANGELOG.md +25 -0
package/README.cn.md +114 -3
package/README.md +106 -5
package/coverage/all-off.js.html +133 -0
package/coverage/base.css +224 -0
package/coverage/block-navigation.js +87 -0
package/coverage/clover.xml +572 -0
package/coverage/consts.js.html +154 -0
package/coverage/default-methods.js.html +2068 -0
package/coverage/event-emitter.js.html +121 -0
package/coverage/event.js.html +286 -0
package/coverage/eventable.js.html +355 -0
package/coverage/favicon.png +0 -0
package/coverage/has-listeners.js.html +166 -0
package/coverage/index.html +281 -0
package/coverage/lcov-report/all-off.js.html +133 -0
package/coverage/lcov-report/base.css +224 -0
package/coverage/lcov-report/block-navigation.js +87 -0
package/coverage/lcov-report/consts.js.html +154 -0
package/coverage/lcov-report/default-methods.js.html +2068 -0
package/coverage/lcov-report/event-emitter.js.html +121 -0
package/coverage/lcov-report/event.js.html +286 -0
package/coverage/lcov-report/eventable.js.html +355 -0
package/coverage/lcov-report/favicon.png +0 -0
package/coverage/lcov-report/has-listeners.js.html +166 -0
package/coverage/lcov-report/index.html +281 -0
package/coverage/lcov-report/once-promise.js.html +325 -0
package/coverage/lcov-report/pipe-async.js.html +385 -0
package/coverage/lcov-report/pipe.js.html +244 -0
package/coverage/lcov-report/prettify.css +1 -0
package/coverage/lcov-report/prettify.js +2 -0
package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
package/coverage/lcov-report/sorter.js +210 -0
package/coverage/lcov-report/unify.js.html +259 -0
package/coverage/lcov-report/wrap-event-emitter.js.html +223 -0
package/coverage/lcov.info +1201 -0
package/coverage/once-promise.js.html +325 -0
package/coverage/pipe-async.js.html +385 -0
package/coverage/pipe.js.html +244 -0
package/coverage/prettify.css +1 -0
package/coverage/prettify.js +2 -0
package/coverage/sort-arrow-sprite.png +0 -0
package/coverage/sorter.js +210 -0
package/coverage/unify.js.html +259 -0
package/coverage/wrap-event-emitter.js.html +223 -0
package/docs/README.md +106 -5
package/docs/all-off/functions/allOff.md +1 -1
package/docs/consts/README.md +4 -0
package/docs/consts/functions/createAbortError.md +18 -0
package/docs/consts/variables/RegExpEventSymbol.md +1 -1
package/docs/consts/variables/states.md +2 -2
package/docs/default-methods/functions/getEventableMethods.md +34 -18
package/docs/event/classes/Event.md +23 -13
package/docs/event-emitter/classes/EventEmitter-1.md +2 -2
package/docs/event-emitter/classes/EventEmitter.md +28 -28
package/docs/eventable/functions/eventable.md +1 -1
package/docs/has-listeners/functions/hasListeners.md +2 -2
package/docs/index/README.md +12 -0
package/docs/modules.md +1 -0
package/docs/once-promise/README.md +17 -0
package/docs/once-promise/functions/oncePromise.md +60 -0
package/docs/pipe/functions/pipe.md +3 -3
package/docs/pipe-async/functions/pipeAsync.md +3 -3
package/docs/unify/functions/unify.md +1 -1
package/docs/util/array-remove/functions/remove.md +1 -1
package/docs/util/object-for-each/functions/forEach.md +1 -1
package/docs/util/string-pad/functions/pad.md +1 -1
package/docs/util/to-int/functions/toInt.md +1 -1
package/docs/util/valid-callable/functions/validCallable.md +1 -1
package/docs/util/valid-object/functions/validObject.md +1 -1
package/docs/wrap-event-emitter/functions/wrapEventEmitter.md +3 -3
package/docs/wrap-event-emitter/variables/methods.md +1 -1
package/lib/all-off.mjs +16 -0
package/lib/consts.d.ts +7 -1
package/lib/consts.js +17 -2
package/lib/consts.mjs +23 -0
package/lib/default-methods.d.ts +12 -4
package/lib/default-methods.js +174 -22
package/lib/default-methods.mjs +661 -0
package/lib/event-emitter.mjs +12 -0
package/lib/event.d.ts +10 -4
package/lib/event.js +6 -0
package/lib/event.mjs +67 -0
package/lib/eventable.d.ts +1 -1
package/lib/eventable.mjs +90 -0
package/lib/has-listeners.d.ts +1 -1
package/lib/has-listeners.mjs +27 -0
package/lib/index.d.ts +1 -0
package/lib/index.js +12 -0
package/lib/index.mjs +16 -0
package/lib/once-promise.d.ts +23 -0
package/lib/once-promise.js +82 -0
package/lib/once-promise.mjs +80 -0
package/lib/pipe-async.d.ts +4 -2
package/lib/pipe-async.js +16 -3
package/lib/pipe-async.mjs +100 -0
package/lib/pipe.d.ts +1 -1
package/lib/pipe.mjs +53 -0
package/lib/unify.js +1 -1
package/lib/unify.mjs +58 -0
package/lib/util/array-remove.mjs +16 -0
package/lib/util/object-for-each.mjs +20 -0
package/lib/util/promise-any.mjs +45 -0
package/lib/util/string-pad.mjs +19 -0
package/lib/util/to-int.mjs +9 -0
package/lib/util/valid-callable.mjs +6 -0
package/lib/util/valid-object.mjs +8 -0
package/lib/wrap-event-emitter.d.ts +1 -1
package/lib/wrap-event-emitter.mjs +46 -0
package/package.json +29 -20
package/scripts/copy-to-mjs.mjs +79 -0
package/src/consts.js +10 -0
package/src/default-methods.js +169 -24
package/src/event.js +6 -0
package/src/index.js +1 -0
package/src/once-promise.js +80 -0
package/src/pipe-async.js +16 -3
package/src/unify.js +1 -1
package/tsconfig.json +2 -1
package/vitest.config.js +61 -0
package/.mocharc.yml +0 -3

package/coverage/once-promise.js.html ADDED Viewed

@@ -0,0 +1,325 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <title>Code coverage report for once-promise.js</title>
+    <meta charset="utf-8" />
+    <link rel="stylesheet" href="prettify.css" />
+    <link rel="stylesheet" href="base.css" />
+    <link rel="shortcut icon" type="image/x-icon" href="favicon.png" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <style type='text/css'>
+        .coverage-summary .sorter {
+            background-image: url(sort-arrow-sprite.png);
+        }
+    </style>
+</head>
+<body>
+<div class='wrapper'>
+    <div class='pad1'>
+        <h1><a href="index.html">All files</a> once-promise.js</h1>
+        <div class='clearfix'>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">100% </span>
+                <span class="quiet">Statements</span>
+                <span class='fraction'>27/27</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">100% </span>
+                <span class="quiet">Branches</span>
+                <span class='fraction'>18/18</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">100% </span>
+                <span class="quiet">Functions</span>
+                <span class='fraction'>6/6</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">100% </span>
+                <span class="quiet">Lines</span>
+                <span class='fraction'>27/27</span>
+            </div>
+        </div>
+        <p class="quiet">
+            Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
+        </p>
+        <template id="filterTemplate">
+            <div class="quiet">
+                Filter:
+                <input type="search" id="fileSearch">
+            </div>
+        </template>
+    </div>
+    <div class='status-line high'></div>
+    <pre><table class="coverage">
+<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
+<a name='L2'></a><a href='#L2'>2</a>
+<a name='L3'></a><a href='#L3'>3</a>
+<a name='L4'></a><a href='#L4'>4</a>
+<a name='L5'></a><a href='#L5'>5</a>
+<a name='L6'></a><a href='#L6'>6</a>
+<a name='L7'></a><a href='#L7'>7</a>
+<a name='L8'></a><a href='#L8'>8</a>
+<a name='L9'></a><a href='#L9'>9</a>
+<a name='L10'></a><a href='#L10'>10</a>
+<a name='L11'></a><a href='#L11'>11</a>
+<a name='L12'></a><a href='#L12'>12</a>
+<a name='L13'></a><a href='#L13'>13</a>
+<a name='L14'></a><a href='#L14'>14</a>
+<a name='L15'></a><a href='#L15'>15</a>
+<a name='L16'></a><a href='#L16'>16</a>
+<a name='L17'></a><a href='#L17'>17</a>
+<a name='L18'></a><a href='#L18'>18</a>
+<a name='L19'></a><a href='#L19'>19</a>
+<a name='L20'></a><a href='#L20'>20</a>
+<a name='L21'></a><a href='#L21'>21</a>
+<a name='L22'></a><a href='#L22'>22</a>
+<a name='L23'></a><a href='#L23'>23</a>
+<a name='L24'></a><a href='#L24'>24</a>
+<a name='L25'></a><a href='#L25'>25</a>
+<a name='L26'></a><a href='#L26'>26</a>
+<a name='L27'></a><a href='#L27'>27</a>
+<a name='L28'></a><a href='#L28'>28</a>
+<a name='L29'></a><a href='#L29'>29</a>
+<a name='L30'></a><a href='#L30'>30</a>
+<a name='L31'></a><a href='#L31'>31</a>
+<a name='L32'></a><a href='#L32'>32</a>
+<a name='L33'></a><a href='#L33'>33</a>
+<a name='L34'></a><a href='#L34'>34</a>
+<a name='L35'></a><a href='#L35'>35</a>
+<a name='L36'></a><a href='#L36'>36</a>
+<a name='L37'></a><a href='#L37'>37</a>
+<a name='L38'></a><a href='#L38'>38</a>
+<a name='L39'></a><a href='#L39'>39</a>
+<a name='L40'></a><a href='#L40'>40</a>
+<a name='L41'></a><a href='#L41'>41</a>
+<a name='L42'></a><a href='#L42'>42</a>
+<a name='L43'></a><a href='#L43'>43</a>
+<a name='L44'></a><a href='#L44'>44</a>
+<a name='L45'></a><a href='#L45'>45</a>
+<a name='L46'></a><a href='#L46'>46</a>
+<a name='L47'></a><a href='#L47'>47</a>
+<a name='L48'></a><a href='#L48'>48</a>
+<a name='L49'></a><a href='#L49'>49</a>
+<a name='L50'></a><a href='#L50'>50</a>
+<a name='L51'></a><a href='#L51'>51</a>
+<a name='L52'></a><a href='#L52'>52</a>
+<a name='L53'></a><a href='#L53'>53</a>
+<a name='L54'></a><a href='#L54'>54</a>
+<a name='L55'></a><a href='#L55'>55</a>
+<a name='L56'></a><a href='#L56'>56</a>
+<a name='L57'></a><a href='#L57'>57</a>
+<a name='L58'></a><a href='#L58'>58</a>
+<a name='L59'></a><a href='#L59'>59</a>
+<a name='L60'></a><a href='#L60'>60</a>
+<a name='L61'></a><a href='#L61'>61</a>
+<a name='L62'></a><a href='#L62'>62</a>
+<a name='L63'></a><a href='#L63'>63</a>
+<a name='L64'></a><a href='#L64'>64</a>
+<a name='L65'></a><a href='#L65'>65</a>
+<a name='L66'></a><a href='#L66'>66</a>
+<a name='L67'></a><a href='#L67'>67</a>
+<a name='L68'></a><a href='#L68'>68</a>
+<a name='L69'></a><a href='#L69'>69</a>
+<a name='L70'></a><a href='#L70'>70</a>
+<a name='L71'></a><a href='#L71'>71</a>
+<a name='L72'></a><a href='#L72'>72</a>
+<a name='L73'></a><a href='#L73'>73</a>
+<a name='L74'></a><a href='#L74'>74</a>
+<a name='L75'></a><a href='#L75'>75</a>
+<a name='L76'></a><a href='#L76'>76</a>
+<a name='L77'></a><a href='#L77'>77</a>
+<a name='L78'></a><a href='#L78'>78</a>
+<a name='L79'></a><a href='#L79'>79</a>
+<a name='L80'></a><a href='#L80'>80</a>
+<a name='L81'></a><a href='#L81'>81</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">55x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">55x</span>
+<span class="cline-any cline-yes">55x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">55x</span>
+<span class="cline-any cline-yes">51x</span>
+<span class="cline-any cline-yes">51x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">51x</span>
+<span class="cline-any cline-yes">50x</span>
+<span class="cline-any cline-yes">50x</span>
+<span class="cline-any cline-yes">45x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">50x</span>
+<span class="cline-any cline-yes">7x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">51x</span>
+<span class="cline-any cline-yes">8x</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">7x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">7x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">33x</span>
+<span class="cline-any cline-yes">33x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">12x</span>
+<span class="cline-any cline-yes">12x</span>
+<span class="cline-any cline-yes">3x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">9x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">50x</span>
+<span class="cline-any cline-yes">50x</span>
+<span class="cline-any cline-yes">45x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">// @sourceType: module
+import validObject from './util/valid-object'
+import {createAbortError} from './consts'
+&nbsp;
+/**
+ * Returns a Promise that resolves with the Event object when the specified event is emitted on the given emitter.
+ * If an 'error' event is emitted (and the waiting event is not 'error'), the promise rejects by default.
+ * If the provided AbortSignal is aborted, the promise rejects with an AbortError.
+ *
+ * Note: The resolved Event object's `result` field may not be the final value if other listeners have not yet run.
+ * For the definitive emit return value, use `emit()` or `emitAsync()` directly.
+ *
+ * @param {import('./event-emitter').EventEmitter} emitter - The event emitter to listen on.
+ * @param {string|RegExp} type - The event type to wait for.
+ * @param {Object} [options] - Optional configuration.
+ * @param {AbortSignal} [options.signal] - An AbortSignal to cancel the wait.
+ * @param {boolean|null} [options.raiseError] - Controls behavior when an 'error' event is emitted:
+ *   - `true` / `undefined` (default): The promise rejects with the error.
+ *   - `false`: The promise resolves with the error object instead of rejecting.
+ * @returns {Promise&lt;import('./event').Event&gt;} - A promise that resolves with the Event object.
+ * @throws {TypeError} - If emitter is not a valid event emitter object.
+ */
+export function oncePromise(emitter, type, options) {
+  validObject(emitter)
+&nbsp;
+  const signal = options &amp;&amp; options.signal
+  const raiseError = options &amp;&amp; options.raiseError
+&nbsp;
+  return new Promise((resolve, reject) =&gt; {
+    let onAbort = null
+    let aborted = false
+&nbsp;
+    const cleanup = () =&gt; {
+      emitter.off(type, onEvent)
+      if (type !== 'error') {
+        emitter.off('error', onError)
+      }
+      if (signal &amp;&amp; onAbort) {
+        signal.removeEventListener('abort', onAbort)
+      }
+    }
+&nbsp;
+    if (signal) {
+      if (signal.aborted) {
+        reject(createAbortError())
+        return
+      }
+      onAbort = () =&gt; {
+        /* v8 ignore next — defensive guard, { once: true } ensures callback fires at most once */
+        if (!aborted) {
+          aborted = true
+          cleanup()
+          reject(createAbortError())
+        }
+      }
+      signal.addEventListener('abort', onAbort, { once: true })
+    }
+&nbsp;
+    function onEvent() {
+      cleanup()
+      resolve(this) // resolve with the Event object
+    }
+&nbsp;
+    function onError(err) {
+      cleanup()
+      if (raiseError === false) {
+        resolve(err) // resolve with the error instead of rejecting
+      } else {
+        reject(err) // true | null | undefined → reject
+      }
+    }
+&nbsp;
+    emitter.on(type, onEvent)
+    if (type !== 'error') {
+      emitter.on('error', onError)
+    }
+  })
+}
+&nbsp;
+export default oncePromise
+&nbsp;</pre></td></tr></table></pre>
+                <div class='push'></div><!-- for sticky footer -->
+            </div><!-- /wrapper -->
+            <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 2026-07-07T07:31:06.609Z
+            </div>
+        <script src="prettify.js"></script>
+        <script>
+            window.onload = function () {
+                prettyPrint();
+            };
+        </script>
+        <script src="sorter.js"></script>
+        <script src="block-navigation.js"></script>
+    </body>
+</html>