amitt 1.0.9 → 1.0.12
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.
- package/README.md +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/AmittEmitter.html +8 -8
- package/docs/index.html +3 -3
- package/docs/modules.html +1 -1
- package/index.d.ts +5 -5
- package/index.mjs +77 -0
- package/package.json +13 -5
package/README.md
CHANGED
package/docs/assets/search.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"128\":\"Class\",\"512\":\"Constructor\",\"2048\":\"Method\",\"4194304\":\"Type alias\"},\"rows\":[{\"id\":0,\"kind\":4194304,\"name\":\"EventType\",\"url\":\"modules.html#EventType\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":1,\"kind\":64,\"name\":\"amitt\",\"url\":\"modules.html#amitt\",\"classes\":\"tsd-kind-function\"},{\"id\":2,\"kind\":128,\"name\":\"AmittEmitter\",\"url\":\"classes/AmittEmitter.html\",\"classes\":\"tsd-kind-class tsd-has-type-parameter\"},{\"id\":3,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/AmittEmitter.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"AmittEmitter\"},{\"id\":4,\"kind\":2048,\"name\":\"once\",\"url\":\"classes/AmittEmitter.html#once\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"AmittEmitter\"},{\"id\":5,\"kind\":2048,\"name\":\"on\",\"url\":\"classes/AmittEmitter.html#on\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"AmittEmitter\"},{\"id\":6,\"kind\":2048,\"name\":\"off\",\"url\":\"classes/AmittEmitter.html#off\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"AmittEmitter\"},{\"id\":7,\"kind\":2048,\"name\":\"emit\",\"url\":\"classes/AmittEmitter.html#emit\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"AmittEmitter\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,17.918]],[\"parent/0\",[]],[\"name/1\",[1,17.918]],[\"parent/1\",[]],[\"name/2\",[2,3.254]],[\"parent/2\",[]],[\"name/3\",[3,17.918]],[\"parent/3\",[2,0.261]],[\"name/4\",[4,17.918]],[\"parent/4\",[2,0.261]],[\"name/5\",[5,17.918]],[\"parent/5\",[2,0.261]],[\"name/6\",[6,17.918]],[\"parent/6\",[2,0.261]],[\"name/7\",[7,17.918]],[\"parent/7\",[2,0.261]]],\"invertedIndex\":[[\"amitt\",{\"_index\":1,\"name\":{\"1\":{}},\"parent\":{}}],[\"amittemitter\",{\"_index\":2,\"name\":{\"2\":{}},\"parent\":{\"3\":{},\"4\":{},\"5\":{},\"6\":{},\"7\":{}}}],[\"constructor\",{\"_index\":3,\"name\":{\"3\":{}},\"parent\":{}}],[\"emit\",{\"_index\":7,\"name\":{\"7\":{}},\"parent\":{}}],[\"eventtype\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{}}],[\"off\",{\"_index\":6,\"name\":{\"6\":{}},\"parent\":{}}],[\"on\",{\"_index\":5,\"name\":{\"5\":{}},\"parent\":{}}],[\"once\",{\"_index\":4,\"name\":{\"4\":{}},\"parent\":{}}]],\"pipeline\":[]}}");
|
|
1
|
+
window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"128\":\"Class\",\"512\":\"Constructor\",\"2048\":\"Method\",\"4194304\":\"Type alias\"},\"rows\":[{\"id\":0,\"kind\":4194304,\"name\":\"EventType\",\"url\":\"modules.html#EventType\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":1,\"kind\":64,\"name\":\"amitt\",\"url\":\"modules.html#amitt\",\"classes\":\"tsd-kind-function tsd-has-type-parameter\"},{\"id\":2,\"kind\":128,\"name\":\"AmittEmitter\",\"url\":\"classes/AmittEmitter.html\",\"classes\":\"tsd-kind-class tsd-has-type-parameter\"},{\"id\":3,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/AmittEmitter.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"AmittEmitter\"},{\"id\":4,\"kind\":2048,\"name\":\"once\",\"url\":\"classes/AmittEmitter.html#once\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"AmittEmitter\"},{\"id\":5,\"kind\":2048,\"name\":\"on\",\"url\":\"classes/AmittEmitter.html#on\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"AmittEmitter\"},{\"id\":6,\"kind\":2048,\"name\":\"off\",\"url\":\"classes/AmittEmitter.html#off\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"AmittEmitter\"},{\"id\":7,\"kind\":2048,\"name\":\"emit\",\"url\":\"classes/AmittEmitter.html#emit\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"AmittEmitter\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,17.918]],[\"parent/0\",[]],[\"name/1\",[1,17.918]],[\"parent/1\",[]],[\"name/2\",[2,3.254]],[\"parent/2\",[]],[\"name/3\",[3,17.918]],[\"parent/3\",[2,0.261]],[\"name/4\",[4,17.918]],[\"parent/4\",[2,0.261]],[\"name/5\",[5,17.918]],[\"parent/5\",[2,0.261]],[\"name/6\",[6,17.918]],[\"parent/6\",[2,0.261]],[\"name/7\",[7,17.918]],[\"parent/7\",[2,0.261]]],\"invertedIndex\":[[\"amitt\",{\"_index\":1,\"name\":{\"1\":{}},\"parent\":{}}],[\"amittemitter\",{\"_index\":2,\"name\":{\"2\":{}},\"parent\":{\"3\":{},\"4\":{},\"5\":{},\"6\":{},\"7\":{}}}],[\"constructor\",{\"_index\":3,\"name\":{\"3\":{}},\"parent\":{}}],[\"emit\",{\"_index\":7,\"name\":{\"7\":{}},\"parent\":{}}],[\"eventtype\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{}}],[\"off\",{\"_index\":6,\"name\":{\"6\":{}},\"parent\":{}}],[\"on\",{\"_index\":5,\"name\":{\"5\":{}},\"parent\":{}}],[\"once\",{\"_index\":4,\"name\":{\"4\":{}},\"parent\":{}}]],\"pipeline\":[]}}");
|
|
@@ -1,29 +1,29 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AmittEmitter | amitt - v1.0.
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AmittEmitter | amitt - v1.0.12</title><meta name="description" content="Documentation for amitt - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">amitt - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">amitt - v1.0.12</a></li><li><a href="AmittEmitter.html">AmittEmitter</a></li></ul><h1>Class AmittEmitter<Keys, Events></h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>package</dt><dd><p>@jwn-js/amitt</p>
|
|
2
2
|
</dd><dt>description</dt><dd><p>async events bus</p>
|
|
3
|
-
</dd></dl></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>Events<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><
|
|
3
|
+
</dd></dl></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>Keys<span class="tsd-signature-symbol">: </span><a href="../modules.html#EventType" class="tsd-signature-type" data-tsd-kind="Type alias">EventType</a> = <span class="tsd-signature-type">any</span></h4></li><li><h4>Events<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">AmittEmitter</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="AmittEmitter.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="AmittEmitter.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="AmittEmitter.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="AmittEmitter.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="AmittEmitter.html#once" class="tsd-kind-icon">once</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>Amitt<wbr/>Emitter<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Events</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AmittEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">AmittEmitter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Events</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Keys<span class="tsd-signature-symbol">: </span><a href="../modules.html#EventType" class="tsd-signature-type" data-tsd-kind="Type alias">EventType</a> = <span class="tsd-signature-type">any</span></h4></li><li><h4>Events<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Events</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul><h4 class="tsd-returns-title">Returns <a href="AmittEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">AmittEmitter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Events</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="emit" class="tsd-anchor"></a><h3 class="tsd-anchor-link">emit<a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../modules.html#EventType" class="tsd-signature-type" data-tsd-kind="Type alias">EventType</a>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/webigorkiev/amitt/blob/dff8667/src/index.ts#L84">index.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
4
|
<p>Invoke all handlers for given type</p>
|
|
5
5
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>U<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span> = <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></h4></li><li><h4>V<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span> = <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <a href="../modules.html#EventType" class="tsd-signature-type" data-tsd-kind="Type alias">EventType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
6
6
|
<p>event type</p>
|
|
7
7
|
</div></div></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
8
8
|
<p>event argiments</p>
|
|
9
9
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span></h4><div><p>array of responses handlers, it can be Promise</p>
|
|
10
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="off" class="tsd-anchor"></a><h3 class="tsd-anchor-link">off<a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type"
|
|
10
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="off" class="tsd-anchor"></a><h3 class="tsd-anchor-link">off<a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/webigorkiev/amitt/blob/dff8667/src/index.ts#L49">index.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
11
11
|
<p>Remove an event handler for given type</p>
|
|
12
|
-
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>U = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type"
|
|
12
|
+
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>U = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
13
13
|
<p>event type</p>
|
|
14
14
|
</div></div></li><li><h5>handler: <span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
15
15
|
<p>handler</p>
|
|
16
16
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><ul>
|
|
17
17
|
<li>is handler has been removed</li>
|
|
18
18
|
</ul>
|
|
19
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="on" class="tsd-anchor"></a><h3 class="tsd-anchor-link">on<a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type"
|
|
19
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="on" class="tsd-anchor"></a><h3 class="tsd-anchor-link">on<a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/webigorkiev/amitt/blob/dff8667/src/index.ts#L35">index.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
20
20
|
<p>Register an event handler for given type</p>
|
|
21
|
-
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>U<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span> = <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></h4></li><li><h4>V = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type"
|
|
21
|
+
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>U<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span> = <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></h4></li><li><h4>V = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
22
22
|
<p>type of event</p>
|
|
23
23
|
</div></div></li><li><h5>handler: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
24
24
|
<p>fantion handler</p>
|
|
25
25
|
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>if handler has been adding</p>
|
|
26
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="once" class="tsd-anchor"></a><h3 class="tsd-anchor-link">once<a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type"
|
|
26
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="once" class="tsd-anchor"></a><h3 class="tsd-anchor-link">once<a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/webigorkiev/amitt/blob/dff8667/src/index.ts#L21">index.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
27
27
|
<p>Set event that invoke only one time</p>
|
|
28
|
-
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>U<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span> = <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></h4></li><li><h4>V = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type"
|
|
28
|
+
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>U<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span> = <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></h4></li><li><h4>V = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span></h5></li><li><h5>handler: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">V</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>is handler added</p>
|
|
29
29
|
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-has-type-parameter"><a href="AmittEmitter.html" class="tsd-kind-icon">Amitt<wbr/>Emitter</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="AmittEmitter.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="AmittEmitter.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="AmittEmitter.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="AmittEmitter.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="AmittEmitter.html#once" class="tsd-kind-icon">once</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
package/docs/index.html
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>amitt - v1.0.
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>amitt - v1.0.12</title><meta name="description" content="Documentation for amitt - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">amitt - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>amitt - v1.0.12</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><h1 align="center"> amitt </h1>
|
|
2
2
|
<p align="center">
|
|
3
3
|
<b>amitt is a simple event emitter for browser and node.js </b>
|
|
4
4
|
</p>
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
<h2>Description</h2>
|
|
9
9
|
</a>
|
|
10
10
|
<p>amitt helps you build functional event emitter / pubsub</p>
|
|
11
|
-
<p>Documentations - <a href="https://webigorkiev.github.io/amitt/">https://webigorkiev.github.io/amitt/</a></p>
|
|
11
|
+
<p>Documentations for types - <a href="https://webigorkiev.github.io/amitt/">https://webigorkiev.github.io/amitt/</a></p>
|
|
12
12
|
|
|
13
13
|
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
|
|
14
14
|
<h2>Installation</h2>
|
|
@@ -47,4 +47,4 @@
|
|
|
47
47
|
</a>
|
|
48
48
|
<pre><code class="language-typescript"><span class="hl-5">const</span><span class="hl-0"> {</span><span class="hl-6">amitt</span><span class="hl-0">} = </span><span class="hl-7">require</span><span class="hl-0">(</span><span class="hl-4">'../dist/index.js'</span><span class="hl-0">);</span><br/><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-6">emitter</span><span class="hl-0"> = </span><span class="hl-7">amitt</span><span class="hl-0">();</span><br/><br/><span class="hl-0">(</span><span class="hl-5">async</span><span class="hl-0">() </span><span class="hl-5">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-2">try</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-7">handler1</span><span class="hl-0"> = </span><span class="hl-5">async</span><span class="hl-0">() </span><span class="hl-5">=></span><span class="hl-0"> </span><span class="hl-2">await</span><span class="hl-0"> </span><span class="hl-5">new</span><span class="hl-0"> </span><span class="hl-8">Promise</span><span class="hl-0">(</span><span class="hl-3">resolve</span><span class="hl-0"> </span><span class="hl-5">=></span><span class="hl-0"> </span><span class="hl-7">setTimeout</span><span class="hl-0">(</span><span class="hl-3">resolve</span><span class="hl-0">, </span><span class="hl-9">1000</span><span class="hl-0">));</span><br/><span class="hl-0"> </span><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-7">handler2</span><span class="hl-0"> = </span><span class="hl-5">async</span><span class="hl-0">() </span><span class="hl-5">=></span><span class="hl-0"> </span><span class="hl-2">await</span><span class="hl-0"> </span><span class="hl-5">new</span><span class="hl-0"> </span><span class="hl-8">Promise</span><span class="hl-0">(</span><span class="hl-3">resolve</span><span class="hl-0"> </span><span class="hl-5">=></span><span class="hl-0"> </span><span class="hl-7">setTimeout</span><span class="hl-0">(</span><span class="hl-3">resolve</span><span class="hl-0">, </span><span class="hl-9">1000</span><span class="hl-0">));</span><br/><br/><span class="hl-0"> </span><span class="hl-3">emitter</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">"fire"</span><span class="hl-0">, </span><span class="hl-3">handler1</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-3">emitter</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">"fire-fight"</span><span class="hl-0">, </span><span class="hl-3">handler2</span><span class="hl-0">);</span><br/><br/><span class="hl-0"> </span><span class="hl-2">await</span><span class="hl-0"> </span><span class="hl-8">Promise</span><span class="hl-0">.</span><span class="hl-7">all</span><span class="hl-0">([...</span><span class="hl-3">emitter</span><span class="hl-0">.</span><span class="hl-7">emit</span><span class="hl-0">(</span><span class="hl-10">/</span><span class="hl-11">^</span><span class="hl-10">fi/</span><span class="hl-0">)]);</span><br/><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">"end"</span><span class="hl-0">);</span><br/><span class="hl-0"> } </span><span class="hl-2">catch</span><span class="hl-0">(</span><span class="hl-3">e</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-3">e</span><span class="hl-0">);</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">})();</span>
|
|
49
49
|
</code></pre>
|
|
50
|
-
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/AmittEmitter.html" class="tsd-kind-icon">Amitt<wbr/>Emitter</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EventType" class="tsd-kind-icon">Event<wbr/>Type</a></li><li class="tsd-kind-function"><a href="modules.html#amitt" class="tsd-kind-icon">amitt</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
|
50
|
+
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/AmittEmitter.html" class="tsd-kind-icon">Amitt<wbr/>Emitter</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EventType" class="tsd-kind-icon">Event<wbr/>Type</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#amitt" class="tsd-kind-icon">amitt</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
package/docs/modules.html
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>amitt - v1.0.
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>amitt - v1.0.12</title><meta name="description" content="Documentation for amitt - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">amitt - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>amitt - v1.0.12</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/AmittEmitter.html" class="tsd-kind-icon">Amitt<wbr/>Emitter</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#EventType" class="tsd-kind-icon">Event<wbr/>Type</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#amitt" class="tsd-kind-icon">amitt</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="EventType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Event<wbr/>Type<a href="#EventType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Event<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/webigorkiev/amitt/blob/dff8667/src/index.ts#L1">index.ts:1</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"><a id="amitt" class="tsd-anchor"></a><h3 class="tsd-anchor-link">amitt<a href="#amitt" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">amitt<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Events</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/AmittEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">AmittEmitter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Events</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/webigorkiev/amitt/blob/dff8667/src/index.ts#L155">index.ts:155</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Keys<span class="tsd-signature-symbol">: </span><a href="modules.html#EventType" class="tsd-signature-type" data-tsd-kind="Type alias">EventType</a></h4></li><li><h4>Events<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Events</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul><h4 class="tsd-returns-title">Returns <a href="classes/AmittEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">AmittEmitter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Keys</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Events</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/AmittEmitter.html" class="tsd-kind-icon">Amitt<wbr/>Emitter</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EventType" class="tsd-kind-icon">Event<wbr/>Type</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#amitt" class="tsd-kind-icon">amitt</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
package/index.d.ts
CHANGED
|
@@ -4,7 +4,7 @@ declare type EventType = string | number | symbol | RegExp;
|
|
|
4
4
|
* @class AsyncEvents
|
|
5
5
|
* @description async events bus
|
|
6
6
|
*/
|
|
7
|
-
declare class AmittEmitter<Events extends Map<
|
|
7
|
+
declare class AmittEmitter<Keys extends EventType = any, Events extends Map<Keys, Set<any>> = Map<Keys, Set<any>>> {
|
|
8
8
|
private onceEvents;
|
|
9
9
|
private events;
|
|
10
10
|
/**
|
|
@@ -13,21 +13,21 @@ declare class AmittEmitter<Events extends Map<EventType, Set<any>>> {
|
|
|
13
13
|
* @param handler
|
|
14
14
|
* @returns is handler added
|
|
15
15
|
*/
|
|
16
|
-
once<U extends any[] = [], V = any>(type:
|
|
16
|
+
once<U extends any[] = [], V = any>(type: Keys, handler: (...args: U) => V | Promise<V>): boolean;
|
|
17
17
|
/**
|
|
18
18
|
* Register an event handler for given type
|
|
19
19
|
* @param type - type of event
|
|
20
20
|
* @param handler - fantion handler
|
|
21
21
|
* @returns if handler has been adding
|
|
22
22
|
*/
|
|
23
|
-
on<U extends any[] = [], V = any>(type:
|
|
23
|
+
on<U extends any[] = [], V = any>(type: Keys, handler: (...args: U) => V | Promise<V>): boolean;
|
|
24
24
|
/**
|
|
25
25
|
* Remove an event handler for given type
|
|
26
26
|
* @param type - event type
|
|
27
27
|
* @param handler handler
|
|
28
28
|
* @returns - is handler has been removed
|
|
29
29
|
*/
|
|
30
|
-
off<U = any>(type:
|
|
30
|
+
off<U = any>(type: Keys, handler: U): boolean;
|
|
31
31
|
/**
|
|
32
32
|
* Invoke all handlers for given type
|
|
33
33
|
* @param type event type
|
|
@@ -43,6 +43,6 @@ declare class AmittEmitter<Events extends Map<EventType, Set<any>>> {
|
|
|
43
43
|
*/
|
|
44
44
|
private addHandler;
|
|
45
45
|
}
|
|
46
|
-
declare const amitt:
|
|
46
|
+
declare const amitt: <Keys extends EventType, Events extends Map<Keys, Set<any>> = Map<Keys, Set<any>>>() => AmittEmitter<Keys, Events>;
|
|
47
47
|
|
|
48
48
|
export { AmittEmitter, EventType, amitt };
|
package/index.mjs
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
class AmittEmitter {
|
|
2
|
+
constructor() {
|
|
3
|
+
this.onceEvents = new Map();
|
|
4
|
+
this.events = new Map();
|
|
5
|
+
}
|
|
6
|
+
once(type, handler) {
|
|
7
|
+
return this.addHandler(this.onceEvents, type, handler);
|
|
8
|
+
}
|
|
9
|
+
on(type, handler) {
|
|
10
|
+
return this.addHandler(this.events, type, handler);
|
|
11
|
+
}
|
|
12
|
+
off(type, handler) {
|
|
13
|
+
for (const store of [this.events, this.onceEvents]) {
|
|
14
|
+
const handlers = store.get(type);
|
|
15
|
+
if (handlers) {
|
|
16
|
+
if (handler) {
|
|
17
|
+
const isDeleted = handlers.delete(handler);
|
|
18
|
+
if (handlers.size === 0) {
|
|
19
|
+
store.delete(type);
|
|
20
|
+
} else {
|
|
21
|
+
store.set(type, handlers);
|
|
22
|
+
}
|
|
23
|
+
return isDeleted;
|
|
24
|
+
} else {
|
|
25
|
+
return store.delete(type);
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
return false;
|
|
30
|
+
}
|
|
31
|
+
emit(type, ...args) {
|
|
32
|
+
const responses = [];
|
|
33
|
+
for (const store of [this.events, this.onceEvents]) {
|
|
34
|
+
const isOnce = store === this.onceEvents;
|
|
35
|
+
const handlersMap = new Map();
|
|
36
|
+
if (type instanceof RegExp) {
|
|
37
|
+
for (const key of store.keys()) {
|
|
38
|
+
if (type.test(key)) {
|
|
39
|
+
handlersMap.set(key, store.get(key));
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
} else {
|
|
43
|
+
handlersMap.set(type, store.get(type));
|
|
44
|
+
}
|
|
45
|
+
for (const key of handlersMap.keys()) {
|
|
46
|
+
const handlers = handlersMap.get(key);
|
|
47
|
+
if (!handlers || !handlers.size) {
|
|
48
|
+
continue;
|
|
49
|
+
}
|
|
50
|
+
for (const handler of handlers) {
|
|
51
|
+
responses.push(handler(...args));
|
|
52
|
+
if (isOnce) {
|
|
53
|
+
handlers.delete(handler);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
if (isOnce) {
|
|
57
|
+
if (handlers.size) {
|
|
58
|
+
store.set(key, handlers);
|
|
59
|
+
} else {
|
|
60
|
+
store.delete(key);
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
return responses;
|
|
66
|
+
}
|
|
67
|
+
addHandler(store, type, handler) {
|
|
68
|
+
const handlers = store.get(type) || new Set();
|
|
69
|
+
const size = handlers.size;
|
|
70
|
+
handlers.add(handler);
|
|
71
|
+
store.set(type, handlers);
|
|
72
|
+
return size !== handlers.size;
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
const amitt = () => new AmittEmitter();
|
|
76
|
+
|
|
77
|
+
export { amitt };
|
package/package.json
CHANGED
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "amitt",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.12",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "amitt is a simple event emitter for browser and node.js",
|
|
6
|
-
"main": "index.js",
|
|
7
|
-
"
|
|
6
|
+
"main": "./index.js",
|
|
7
|
+
"module": "./index.mjs",
|
|
8
|
+
"types": "./index.d.ts",
|
|
8
9
|
"scripts": {
|
|
9
10
|
"build": "yarn docs && node scripts/build.js",
|
|
10
11
|
"test": "ts-mocha --paths -p tsconfig.json --recursive ./src/**/*.{js,cjs,mjs,ts} ./test/unit/**/*.{js,cjs,mjs,ts}",
|
|
11
12
|
"lint": "eslint src/** --ignore-path ./.eslintignore",
|
|
12
|
-
"docs": "typedoc --includeVersion --excludePrivate --out docs src/index.ts"
|
|
13
|
+
"docs": "typedoc --includeVersion --excludePrivate --out docs src/index.ts",
|
|
14
|
+
"deploy": "node deploy.mjs"
|
|
13
15
|
},
|
|
14
16
|
"keywords": [
|
|
15
17
|
"emitter",
|
|
@@ -23,6 +25,10 @@
|
|
|
23
25
|
"type": "git",
|
|
24
26
|
"url": "https://github.com/webigorkiev/amitt.git"
|
|
25
27
|
},
|
|
28
|
+
"bugs": {
|
|
29
|
+
"url": "https://github.com/webigorkiev/amitt/issues"
|
|
30
|
+
},
|
|
31
|
+
"homepage": "https://github.com/webigorkiev/amitt",
|
|
26
32
|
"author": "webigorkiev",
|
|
27
33
|
"license": "MIT",
|
|
28
34
|
"devDependencies": {
|
|
@@ -36,8 +42,10 @@
|
|
|
36
42
|
"chai-http": "^4.3.0",
|
|
37
43
|
"esbuild": "^0.12.20",
|
|
38
44
|
"eslint": "^7.26.0",
|
|
39
|
-
"fs-extra": "^10.0.
|
|
45
|
+
"fs-extra": "^10.0.1",
|
|
46
|
+
"margv": "^1.1.2",
|
|
40
47
|
"mocha": "^8.4.0",
|
|
48
|
+
"prompts": "^2.4.2",
|
|
41
49
|
"rollup": "^2.56.2",
|
|
42
50
|
"rollup-plugin-dts": "^3.0.2",
|
|
43
51
|
"rollup-plugin-esbuild": "^4.5.0",
|