0.0.13-alpha
Signed-off-by: AlienTornadosaurusHex <>
This commit is contained in:
AlienTornadosaurusHex
parent
c5478b159d
commit
19c687c9d2
211 changed files with 10991 additions and 216 deletions
|
|
@ -25,7 +25,7 @@
|
|||
<ul class="tsd-hierarchy">
|
||||
<li><a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:61</li></ul></aside>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:62</li></ul></aside>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
||||
|
|
@ -81,14 +81,14 @@
|
|||
<h4 class="tsd-returns-title">Returns <a href="Network.Synchronizer.html" class="tsd-signature-type tsd-kind-class">Synchronizer</a></h4><aside class="tsd-sources">
|
||||
<p>Overrides EventEmitter.constructor</p>
|
||||
<ul>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:63</li></ul></aside></li></ul></section></section>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:64</li></ul></aside></li></ul></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member"><a id="caches" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>caches</span><a href="#caches" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature"><span class="tsd-kind-property">caches</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">string</span><span class="tsd-signature-symbol">, </span><a href="Data.Cache.Syncable.html" class="tsd-signature-type tsd-kind-class">Syncable</a><span class="tsd-signature-symbol"><</span><a href="../modules/Data.html" class="tsd-signature-type tsd-kind-namespace">Data</a><span class="tsd-signature-symbol">.</span><a href="../modules/Data.Docs.html" class="tsd-signature-type tsd-kind-namespace">Docs</a><span class="tsd-signature-symbol">.</span><a href="Data.Docs.Base.html" class="tsd-signature-type tsd-kind-class">Base</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:62</li></ul></aside></section>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:63</li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>capture<wbr/>Rejection<wbr/>Symbol</span><a href="#captureRejectionSymbol" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature"><span class="tsd-kind-property">capture<wbr/>Rejection<wbr/>Symbol</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="Network.Synchronizer.html#captureRejectionSymbol" class="tsd-signature-type tsd-kind-property">captureRejectionSymbol</a></div><aside class="tsd-sources">
|
||||
|
|
@ -136,7 +136,7 @@ regular <code>'error'</code> listener is installed.</p>
|
|||
<h5><span class="tsd-kind-parameter">options</span>: <a href="../modules/Network.html" class="tsd-signature-type tsd-kind-namespace">Network</a><span class="tsd-signature-symbol">.</span><a href="../modules/Network.Options.html" class="tsd-signature-type tsd-kind-namespace">Options</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Network.Options.Sync.html" class="tsd-signature-type tsd-kind-interface">Sync</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">blockDelta</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">blockDivisor</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">concurrencyLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">listenForEvents</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">msTimeout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">startBlock</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">targetBlock</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:68</li></ul></aside></li></ul></section>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:69</li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addListener" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>add<wbr/>Listener</span><a href="#addListener" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||||
|
|
@ -184,7 +184,7 @@ regular <code>'error'</code> listener is installed.</p>
|
|||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">listenerIndex</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:67</li></ul></aside></li></ul></section>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:68</li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="emit" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||||
|
|
@ -193,7 +193,7 @@ regular <code>'error'</code> listener is installed.</p>
|
|||
<div class="tsd-comment tsd-typography"><p>Synchronously calls each of the listeners registered for the event named<code>eventName</code>, in the order they were registered, passing the supplied arguments
|
||||
to each.</p>
|
||||
<p>Returns <code>true</code> if the event had listeners, <code>false</code> otherwise.</p>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">EventEmitter</span><span class="hl-0"> = </span><span class="hl-5">require</span><span class="hl-0">(</span><span class="hl-6">'events'</span><span class="hl-0">);</span><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">myEmitter</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-7">// First listener</span><br/><span class="hl-1">myEmitter</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'event'</span><span class="hl-0">, </span><span class="hl-3">function</span><span class="hl-0"> </span><span class="hl-5">firstListener</span><span class="hl-0">() {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'Helloooo! first listener'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><span class="hl-7">// Second listener</span><br/><span class="hl-1">myEmitter</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'event'</span><span class="hl-0">, </span><span class="hl-3">function</span><span class="hl-0"> </span><span class="hl-5">secondListener</span><span class="hl-0">(</span><span class="hl-1">arg1</span><span class="hl-0">, </span><span class="hl-1">arg2</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">`event with parameters </span><span class="hl-3">${</span><span class="hl-1">arg1</span><span class="hl-3">}</span><span class="hl-6">, </span><span class="hl-3">${</span><span class="hl-1">arg2</span><span class="hl-3">}</span><span class="hl-6"> in second listener`</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><span class="hl-7">// Third listener</span><br/><span class="hl-1">myEmitter</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'event'</span><span class="hl-0">, </span><span class="hl-3">function</span><span class="hl-0"> </span><span class="hl-5">thirdListener</span><span class="hl-0">(...</span><span class="hl-1">args</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">parameters</span><span class="hl-0"> = </span><span class="hl-1">args</span><span class="hl-0">.</span><span class="hl-5">join</span><span class="hl-0">(</span><span class="hl-6">', '</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">`event with parameters </span><span class="hl-3">${</span><span class="hl-1">parameters</span><span class="hl-3">}</span><span class="hl-6"> in third listener`</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-1">myEmitter</span><span class="hl-0">.</span><span class="hl-5">listeners</span><span class="hl-0">(</span><span class="hl-6">'event'</span><span class="hl-0">));</span><br/><br/><span class="hl-1">myEmitter</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'event'</span><span class="hl-0">, </span><span class="hl-2">1</span><span class="hl-0">, </span><span class="hl-2">2</span><span class="hl-0">, </span><span class="hl-2">3</span><span class="hl-0">, </span><span class="hl-2">4</span><span class="hl-0">, </span><span class="hl-2">5</span><span class="hl-0">);</span><br/><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// [</span><br/><span class="hl-7">// [Function: firstListener],</span><br/><span class="hl-7">// [Function: secondListener],</span><br/><span class="hl-7">// [Function: thirdListener]</span><br/><span class="hl-7">// ]</span><br/><span class="hl-7">// Helloooo! first listener</span><br/><span class="hl-7">// event with parameters 1, 2 in second listener</span><br/><span class="hl-7">// event with parameters 1, 2, 3, 4, 5 in third listener</span>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1"> = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEmitter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-7">// First listener</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, </span><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-5">firstListener</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'Helloooo! first listener'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-7">// Second listener</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, </span><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-5">secondListener</span><span class="hl-1">(</span><span class="hl-0">arg1</span><span class="hl-1">, </span><span class="hl-0">arg2</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">`event with parameters </span><span class="hl-3">${</span><span class="hl-0">arg1</span><span class="hl-3">}</span><span class="hl-6">, </span><span class="hl-3">${</span><span class="hl-0">arg2</span><span class="hl-3">}</span><span class="hl-6"> in second listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-7">// Third listener</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, </span><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-5">thirdListener</span><span class="hl-1">(...</span><span class="hl-0">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">parameters</span><span class="hl-1"> = </span><span class="hl-0">args</span><span class="hl-1">.</span><span class="hl-5">join</span><span class="hl-1">(</span><span class="hl-6">', '</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">`event with parameters </span><span class="hl-3">${</span><span class="hl-0">parameters</span><span class="hl-3">}</span><span class="hl-6"> in third listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">listeners</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">));</span><br/><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, </span><span class="hl-2">1</span><span class="hl-1">, </span><span class="hl-2">2</span><span class="hl-1">, </span><span class="hl-2">3</span><span class="hl-1">, </span><span class="hl-2">4</span><span class="hl-1">, </span><span class="hl-2">5</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// [</span><br/><span class="hl-7">// [Function: firstListener],</span><br/><span class="hl-7">// [Function: secondListener],</span><br/><span class="hl-7">// [Function: thirdListener]</span><br/><span class="hl-7">// ]</span><br/><span class="hl-7">// Helloooo! first listener</span><br/><span class="hl-7">// event with parameters 1, 2 in second listener</span><br/><span class="hl-7">// event with parameters 1, 2, 3, 4, 5 in third listener</span>
|
||||
</code><button>Copy</button></pre>
|
||||
|
||||
<h3>Since</h3><p>v0.1.26</p>
|
||||
|
|
@ -216,7 +216,7 @@ to each.</p>
|
|||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Returns an array listing the events for which the emitter has registered
|
||||
listeners. The values in the array are strings or <code>Symbol</code>s.</p>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">EventEmitter</span><span class="hl-0"> = </span><span class="hl-5">require</span><span class="hl-0">(</span><span class="hl-6">'events'</span><span class="hl-0">);</span><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">myEE</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-1">myEE</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'foo'</span><span class="hl-0">, () </span><span class="hl-3">=></span><span class="hl-0"> {});</span><br/><span class="hl-1">myEE</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'bar'</span><span class="hl-0">, () </span><span class="hl-3">=></span><span class="hl-0"> {});</span><br/><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">sym</span><span class="hl-0"> = </span><span class="hl-5">Symbol</span><span class="hl-0">(</span><span class="hl-6">'symbol'</span><span class="hl-0">);</span><br/><span class="hl-1">myEE</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-1">sym</span><span class="hl-0">, () </span><span class="hl-3">=></span><span class="hl-0"> {});</span><br/><br/><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-1">myEE</span><span class="hl-0">.</span><span class="hl-5">eventNames</span><span class="hl-0">());</span><br/><span class="hl-7">// Prints: [ 'foo', 'bar', Symbol(symbol) ]</span>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1"> = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEE</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {});</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'bar'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {});</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">sym</span><span class="hl-1"> = </span><span class="hl-5">Symbol</span><span class="hl-1">(</span><span class="hl-6">'symbol'</span><span class="hl-1">);</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-0">sym</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {});</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">eventNames</span><span class="hl-1">());</span><br/><span class="hl-7">// Prints: [ 'foo', 'bar', Symbol(symbol) ]</span>
|
||||
</code><button>Copy</button></pre>
|
||||
|
||||
<h3>Since</h3><p>v6.0.0</p>
|
||||
|
|
@ -257,7 +257,7 @@ set by <code>emitter.setMaxListeners(n)</code> or defaults to <a href="Network.S
|
|||
<h5><span class="tsd-kind-parameter">cache</span>: <a href="Data.Cache.Syncable.html" class="tsd-signature-type tsd-kind-class">Syncable</a><span class="tsd-signature-symbol"><</span><a href="../modules/Data.html" class="tsd-signature-type tsd-kind-namespace">Data</a><span class="tsd-signature-symbol">.</span><a href="../modules/Data.Docs.html" class="tsd-signature-type tsd-kind-namespace">Docs</a><span class="tsd-signature-symbol">.</span><a href="Data.Docs.Base.html" class="tsd-signature-type tsd-kind-class">Base</a><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:66</li></ul></aside></li></ul></section>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:67</li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listenerCount" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>listener<wbr/>Count</span><a href="#listenerCount" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||||
|
|
@ -290,7 +290,7 @@ is found in the list of the listeners of the event.</p>
|
|||
<li class="tsd-signature tsd-anchor-link" id="listeners.listeners-1"><span class="tsd-kind-call-signature">listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span><a href="#listeners.listeners-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
|
||||
<pre><code class="language-js"><span class="hl-1">server</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'connection'</span><span class="hl-0">, (</span><span class="hl-1">stream</span><span class="hl-0">) </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'someone connected!'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-1">util</span><span class="hl-0">.</span><span class="hl-5">inspect</span><span class="hl-0">(</span><span class="hl-1">server</span><span class="hl-0">.</span><span class="hl-5">listeners</span><span class="hl-0">(</span><span class="hl-6">'connection'</span><span class="hl-0">)));</span><br/><span class="hl-7">// Prints: [ [Function] ]</span>
|
||||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">util</span><span class="hl-1">.</span><span class="hl-5">inspect</span><span class="hl-1">(</span><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">listeners</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">)));</span><br/><span class="hl-7">// Prints: [ [Function] ]</span>
|
||||
</code><button>Copy</button></pre>
|
||||
|
||||
<h3>Since</h3><p>v0.1.26</p>
|
||||
|
|
@ -323,7 +323,7 @@ is found in the list of the listeners of the event.</p>
|
|||
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">C</span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:65</li></ul></aside></li></ul></section>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:66</li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="off" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||||
|
|
@ -364,12 +364,12 @@ is found in the list of the listeners of the event.</p>
|
|||
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
||||
already been added. Multiple calls passing the same combination of <code>eventName</code>and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
||||
times.</p>
|
||||
<pre><code class="language-js"><span class="hl-1">server</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'connection'</span><span class="hl-0">, (</span><span class="hl-1">stream</span><span class="hl-0">) </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'someone connected!'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span>
|
||||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
</code><button>Copy</button></pre>
|
||||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||||
<p>By default, event listeners are invoked in the order they are added. The<code>emitter.prependListener()</code> method can be used as an alternative to add the
|
||||
event listener to the beginning of the listeners array.</p>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">myEE</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-1">myEE</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'foo'</span><span class="hl-0">, () </span><span class="hl-3">=></span><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'a'</span><span class="hl-0">));</span><br/><span class="hl-1">myEE</span><span class="hl-0">.</span><span class="hl-5">prependListener</span><span class="hl-0">(</span><span class="hl-6">'foo'</span><span class="hl-0">, () </span><span class="hl-3">=></span><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'b'</span><span class="hl-0">));</span><br/><span class="hl-1">myEE</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'foo'</span><span class="hl-0">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// b</span><br/><span class="hl-7">// a</span>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEE</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'a'</span><span class="hl-1">));</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">prependListener</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'b'</span><span class="hl-1">));</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// b</span><br/><span class="hl-7">// a</span>
|
||||
</code><button>Copy</button></pre>
|
||||
|
||||
<h3>Since</h3><p>v0.1.101</p>
|
||||
|
|
@ -407,12 +407,12 @@ event listener to the beginning of the listeners array.</p>
|
|||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code>. The
|
||||
next time <code>eventName</code> is triggered, this listener is removed and then invoked.</p>
|
||||
<pre><code class="language-js"><span class="hl-1">server</span><span class="hl-0">.</span><span class="hl-5">once</span><span class="hl-0">(</span><span class="hl-6">'connection'</span><span class="hl-0">, (</span><span class="hl-1">stream</span><span class="hl-0">) </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'Ah, we have our first user!'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span>
|
||||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'Ah, we have our first user!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
</code><button>Copy</button></pre>
|
||||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||||
<p>By default, event listeners are invoked in the order they are added. The<code>emitter.prependOnceListener()</code> method can be used as an alternative to add the
|
||||
event listener to the beginning of the listeners array.</p>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">myEE</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-1">myEE</span><span class="hl-0">.</span><span class="hl-5">once</span><span class="hl-0">(</span><span class="hl-6">'foo'</span><span class="hl-0">, () </span><span class="hl-3">=></span><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'a'</span><span class="hl-0">));</span><br/><span class="hl-1">myEE</span><span class="hl-0">.</span><span class="hl-5">prependOnceListener</span><span class="hl-0">(</span><span class="hl-6">'foo'</span><span class="hl-0">, () </span><span class="hl-3">=></span><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'b'</span><span class="hl-0">));</span><br/><span class="hl-1">myEE</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'foo'</span><span class="hl-0">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// b</span><br/><span class="hl-7">// a</span>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEE</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'a'</span><span class="hl-1">));</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">prependOnceListener</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'b'</span><span class="hl-1">));</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// b</span><br/><span class="hl-7">// a</span>
|
||||
</code><button>Copy</button></pre>
|
||||
|
||||
<h3>Since</h3><p>v0.3.0</p>
|
||||
|
|
@ -452,7 +452,7 @@ event listener to the beginning of the listeners array.</p>
|
|||
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
||||
already been added. Multiple calls passing the same combination of <code>eventName</code>and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
||||
times.</p>
|
||||
<pre><code class="language-js"><span class="hl-1">server</span><span class="hl-0">.</span><span class="hl-5">prependListener</span><span class="hl-0">(</span><span class="hl-6">'connection'</span><span class="hl-0">, (</span><span class="hl-1">stream</span><span class="hl-0">) </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'someone connected!'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span>
|
||||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">prependListener</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
</code><button>Copy</button></pre>
|
||||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||||
|
||||
|
|
@ -491,7 +491,7 @@ times.</p>
|
|||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code> to the <em>beginning</em> of the listeners array. The next time <code>eventName</code> is triggered, this
|
||||
listener is removed, and then invoked.</p>
|
||||
<pre><code class="language-js"><span class="hl-1">server</span><span class="hl-0">.</span><span class="hl-5">prependOnceListener</span><span class="hl-0">(</span><span class="hl-6">'connection'</span><span class="hl-0">, (</span><span class="hl-1">stream</span><span class="hl-0">) </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'Ah, we have our first user!'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span>
|
||||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">prependOnceListener</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'Ah, we have our first user!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||||
</code><button>Copy</button></pre>
|
||||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||||
|
||||
|
|
@ -530,7 +530,7 @@ listener is removed, and then invoked.</p>
|
|||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>,
|
||||
including any wrappers (such as those created by <code>.once()</code>).</p>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">emitter</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-1">emitter</span><span class="hl-0">.</span><span class="hl-5">once</span><span class="hl-0">(</span><span class="hl-6">'log'</span><span class="hl-0">, () </span><span class="hl-3">=></span><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'log once'</span><span class="hl-0">));</span><br/><br/><span class="hl-7">// Returns a new Array with a function `onceWrapper` which has a property</span><br/><span class="hl-7">// `listener` which contains the original listener bound above</span><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">listeners</span><span class="hl-0"> = </span><span class="hl-1">emitter</span><span class="hl-0">.</span><span class="hl-5">rawListeners</span><span class="hl-0">(</span><span class="hl-6">'log'</span><span class="hl-0">);</span><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">logFnWrapper</span><span class="hl-0"> = </span><span class="hl-1">listeners</span><span class="hl-0">[</span><span class="hl-2">0</span><span class="hl-0">];</span><br/><br/><span class="hl-7">// Logs "log once" to the console and does not unbind the `once` event</span><br/><span class="hl-1">logFnWrapper</span><span class="hl-0">.</span><span class="hl-5">listener</span><span class="hl-0">();</span><br/><br/><span class="hl-7">// Logs "log once" to the console and removes the listener</span><br/><span class="hl-5">logFnWrapper</span><span class="hl-0">();</span><br/><br/><span class="hl-1">emitter</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'log'</span><span class="hl-0">, () </span><span class="hl-3">=></span><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'log persistently'</span><span class="hl-0">));</span><br/><span class="hl-7">// Will return a new Array with a single function bound by `.on()` above</span><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">newListeners</span><span class="hl-0"> = </span><span class="hl-1">emitter</span><span class="hl-0">.</span><span class="hl-5">rawListeners</span><span class="hl-0">(</span><span class="hl-6">'log'</span><span class="hl-0">);</span><br/><br/><span class="hl-7">// Logs "log persistently" twice</span><br/><span class="hl-1">newListeners</span><span class="hl-0">[</span><span class="hl-2">0</span><span class="hl-0">]();</span><br/><span class="hl-1">emitter</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'log'</span><span class="hl-0">);</span>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">emitter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-6">'log'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'log once'</span><span class="hl-1">));</span><br/><br/><span class="hl-7">// Returns a new Array with a function `onceWrapper` which has a property</span><br/><span class="hl-7">// `listener` which contains the original listener bound above</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">listeners</span><span class="hl-1"> = </span><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-5">rawListeners</span><span class="hl-1">(</span><span class="hl-6">'log'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">logFnWrapper</span><span class="hl-1"> = </span><span class="hl-0">listeners</span><span class="hl-1">[</span><span class="hl-2">0</span><span class="hl-1">];</span><br/><br/><span class="hl-7">// Logs "log once" to the console and does not unbind the `once` event</span><br/><span class="hl-0">logFnWrapper</span><span class="hl-1">.</span><span class="hl-5">listener</span><span class="hl-1">();</span><br/><br/><span class="hl-7">// Logs "log once" to the console and removes the listener</span><br/><span class="hl-5">logFnWrapper</span><span class="hl-1">();</span><br/><br/><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'log'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'log persistently'</span><span class="hl-1">));</span><br/><span class="hl-7">// Will return a new Array with a single function bound by `.on()` above</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">newListeners</span><span class="hl-1"> = </span><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-5">rawListeners</span><span class="hl-1">(</span><span class="hl-6">'log'</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// Logs "log persistently" twice</span><br/><span class="hl-0">newListeners</span><span class="hl-1">[</span><span class="hl-2">0</span><span class="hl-1">]();</span><br/><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'log'</span><span class="hl-1">);</span>
|
||||
</code><button>Copy</button></pre>
|
||||
|
||||
<h3>Since</h3><p>v9.4.0</p>
|
||||
|
|
@ -572,7 +572,7 @@ component or module (e.g. sockets or file streams).</p>
|
|||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-1"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Network.Synchronizer.html" class="tsd-signature-type tsd-kind-class">Synchronizer</a><a href="#removeListener.removeListener-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>Removes the specified <code>listener</code> from the listener array for the event named<code>eventName</code>.</p>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-5">callback</span><span class="hl-0"> = (</span><span class="hl-1">stream</span><span class="hl-0">) </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'someone connected!'</span><span class="hl-0">);</span><br/><span class="hl-0">};</span><br/><span class="hl-1">server</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'connection'</span><span class="hl-0">, </span><span class="hl-1">callback</span><span class="hl-0">);</span><br/><span class="hl-7">// ...</span><br/><span class="hl-1">server</span><span class="hl-0">.</span><span class="hl-5">removeListener</span><span class="hl-0">(</span><span class="hl-6">'connection'</span><span class="hl-0">, </span><span class="hl-1">callback</span><span class="hl-0">);</span>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-5">callback</span><span class="hl-1"> = (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">, </span><span class="hl-0">callback</span><span class="hl-1">);</span><br/><span class="hl-7">// ...</span><br/><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">removeListener</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">, </span><span class="hl-0">callback</span><span class="hl-1">);</span>
|
||||
</code><button>Copy</button></pre>
|
||||
<p><code>removeListener()</code> will remove, at most, one instance of a listener from the
|
||||
listener array. If any single listener has been added multiple times to the
|
||||
|
|
@ -581,7 +581,7 @@ called multiple times to remove each instance.</p>
|
|||
<p>Once an event is emitted, all listeners attached to it at the
|
||||
time of emitting are called in order. This implies that any<code>removeListener()</code> or <code>removeAllListeners()</code> calls <em>after</em> emitting and <em>before</em> the last listener finishes execution
|
||||
will not remove them from<code>emit()</code> in progress. Subsequent events behave as expected.</p>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">myEmitter</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">MyEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-5">callbackA</span><span class="hl-0"> = () </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'A'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-1">myEmitter</span><span class="hl-0">.</span><span class="hl-5">removeListener</span><span class="hl-0">(</span><span class="hl-6">'event'</span><span class="hl-0">, </span><span class="hl-1">callbackB</span><span class="hl-0">);</span><br/><span class="hl-0">};</span><br/><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-5">callbackB</span><span class="hl-0"> = () </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'B'</span><span class="hl-0">);</span><br/><span class="hl-0">};</span><br/><br/><span class="hl-1">myEmitter</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'event'</span><span class="hl-0">, </span><span class="hl-1">callbackA</span><span class="hl-0">);</span><br/><br/><span class="hl-1">myEmitter</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'event'</span><span class="hl-0">, </span><span class="hl-1">callbackB</span><span class="hl-0">);</span><br/><br/><span class="hl-7">// callbackA removes listener callbackB but it will still be called.</span><br/><span class="hl-7">// Internal listener array at time of emit [callbackA, callbackB]</span><br/><span class="hl-1">myEmitter</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'event'</span><span class="hl-0">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// A</span><br/><span class="hl-7">// B</span><br/><br/><span class="hl-7">// callbackB is now removed.</span><br/><span class="hl-7">// Internal listener array [callbackA]</span><br/><span class="hl-1">myEmitter</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'event'</span><span class="hl-0">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// A</span>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEmitter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">MyEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-5">callbackA</span><span class="hl-1"> = () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'A'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">removeListener</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, </span><span class="hl-0">callbackB</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-5">callbackB</span><span class="hl-1"> = () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'B'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, </span><span class="hl-0">callbackA</span><span class="hl-1">);</span><br/><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, </span><span class="hl-0">callbackB</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// callbackA removes listener callbackB but it will still be called.</span><br/><span class="hl-7">// Internal listener array at time of emit [callbackA, callbackB]</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// A</span><br/><span class="hl-7">// B</span><br/><br/><span class="hl-7">// callbackB is now removed.</span><br/><span class="hl-7">// Internal listener array [callbackA]</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// A</span>
|
||||
</code><button>Copy</button></pre>
|
||||
<p>Because listeners are managed using an internal array, calling this will
|
||||
change the position indices of any listener registered <em>after</em> the listener
|
||||
|
|
@ -591,7 +591,7 @@ the <code>emitter.listeners()</code> method will need to be recreated.</p>
|
|||
<p>When a single function has been added as a handler multiple times for a single
|
||||
event (as in the example below), <code>removeListener()</code> will remove the most
|
||||
recently added instance. In the example the <code>once('ping')</code>listener is removed:</p>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">ee</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-3">function</span><span class="hl-0"> </span><span class="hl-5">pong</span><span class="hl-0">() {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'pong'</span><span class="hl-0">);</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-1">ee</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'ping'</span><span class="hl-0">, </span><span class="hl-1">pong</span><span class="hl-0">);</span><br/><span class="hl-1">ee</span><span class="hl-0">.</span><span class="hl-5">once</span><span class="hl-0">(</span><span class="hl-6">'ping'</span><span class="hl-0">, </span><span class="hl-1">pong</span><span class="hl-0">);</span><br/><span class="hl-1">ee</span><span class="hl-0">.</span><span class="hl-5">removeListener</span><span class="hl-0">(</span><span class="hl-6">'ping'</span><span class="hl-0">, </span><span class="hl-1">pong</span><span class="hl-0">);</span><br/><br/><span class="hl-1">ee</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'ping'</span><span class="hl-0">);</span><br/><span class="hl-1">ee</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'ping'</span><span class="hl-0">);</span>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-5">pong</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'pong'</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'ping'</span><span class="hl-1">, </span><span class="hl-0">pong</span><span class="hl-1">);</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-6">'ping'</span><span class="hl-1">, </span><span class="hl-0">pong</span><span class="hl-1">);</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">removeListener</span><span class="hl-1">(</span><span class="hl-6">'ping'</span><span class="hl-1">, </span><span class="hl-0">pong</span><span class="hl-1">);</span><br/><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'ping'</span><span class="hl-1">);</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'ping'</span><span class="hl-1">);</span>
|
||||
</code><button>Copy</button></pre>
|
||||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||||
|
||||
|
|
@ -661,7 +661,7 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
|
|||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../modules/Network.html" class="tsd-signature-type tsd-kind-namespace">Network</a><span class="tsd-signature-symbol">.</span><a href="../modules/Network.Options.html" class="tsd-signature-type tsd-kind-namespace">Options</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Network.Options.Sync.html" class="tsd-signature-type tsd-kind-interface">Sync</a></h5></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:64</li></ul></aside></li></ul></section>
|
||||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:65</li></ul></aside></li></ul></section>
|
||||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getEventListeners" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Event<wbr/>Listeners</span><a href="#getEventListeners" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||||
|
|
@ -672,7 +672,7 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
|
|||
the emitter.</p>
|
||||
<p>For <code>EventTarget</code>s this is the only way to get the event listeners for the
|
||||
event target. This is useful for debugging and diagnostic purposes.</p>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> { </span><span class="hl-4">getEventListeners</span><span class="hl-0">, </span><span class="hl-4">EventEmitter</span><span class="hl-0"> } = </span><span class="hl-5">require</span><span class="hl-0">(</span><span class="hl-6">'events'</span><span class="hl-0">);</span><br/><br/><span class="hl-0">{</span><br/><span class="hl-0"> </span><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">ee</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-0"> </span><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-5">listener</span><span class="hl-0"> = () </span><span class="hl-3">=></span><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'Events are fun'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-1">ee</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'foo'</span><span class="hl-0">, </span><span class="hl-1">listener</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">getEventListeners</span><span class="hl-0">(</span><span class="hl-1">ee</span><span class="hl-0">, </span><span class="hl-6">'foo'</span><span class="hl-0">); </span><span class="hl-7">// [listener]</span><br/><span class="hl-0">}</span><br/><span class="hl-0">{</span><br/><span class="hl-0"> </span><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">et</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventTarget</span><span class="hl-0">();</span><br/><span class="hl-0"> </span><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-5">listener</span><span class="hl-0"> = () </span><span class="hl-3">=></span><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'Events are fun'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-1">et</span><span class="hl-0">.</span><span class="hl-5">addEventListener</span><span class="hl-0">(</span><span class="hl-6">'foo'</span><span class="hl-0">, </span><span class="hl-1">listener</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">getEventListeners</span><span class="hl-0">(</span><span class="hl-1">et</span><span class="hl-0">, </span><span class="hl-6">'foo'</span><span class="hl-0">); </span><span class="hl-7">// [listener]</span><br/><span class="hl-0">}</span>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">getEventListeners</span><span class="hl-1">, </span><span class="hl-4">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-5">listener</span><span class="hl-1"> = () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'Events are fun'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, </span><span class="hl-0">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-5">getEventListeners</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-6">'foo'</span><span class="hl-1">); </span><span class="hl-7">// [listener]</span><br/><span class="hl-1">}</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">et</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventTarget</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-5">listener</span><span class="hl-1"> = () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'Events are fun'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">et</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, </span><span class="hl-0">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-5">getEventListeners</span><span class="hl-1">(</span><span class="hl-0">et</span><span class="hl-1">, </span><span class="hl-6">'foo'</span><span class="hl-1">); </span><span class="hl-7">// [listener]</span><br/><span class="hl-1">}</span>
|
||||
</code><button>Copy</button></pre>
|
||||
|
||||
<h3>Since</h3><p>v15.2.0, v14.17.0</p>
|
||||
|
|
@ -694,7 +694,7 @@ event target. This is useful for debugging and diagnostic purposes.</p>
|
|||
<li class="tsd-signature tsd-anchor-link" id="listenerCount-2.listenerCount-3"><span class="tsd-kind-call-signature">listener<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#listenerCount-2.listenerCount-3" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><p>A class method that returns the number of listeners for the given <code>eventName</code>registered on the given <code>emitter</code>.</p>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> { </span><span class="hl-4">EventEmitter</span><span class="hl-0">, </span><span class="hl-4">listenerCount</span><span class="hl-0"> } = </span><span class="hl-5">require</span><span class="hl-0">(</span><span class="hl-6">'events'</span><span class="hl-0">);</span><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">myEmitter</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-1">myEmitter</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'event'</span><span class="hl-0">, () </span><span class="hl-3">=></span><span class="hl-0"> {});</span><br/><span class="hl-1">myEmitter</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-6">'event'</span><span class="hl-0">, () </span><span class="hl-3">=></span><span class="hl-0"> {});</span><br/><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-5">listenerCount</span><span class="hl-0">(</span><span class="hl-1">myEmitter</span><span class="hl-0">, </span><span class="hl-6">'event'</span><span class="hl-0">));</span><br/><span class="hl-7">// Prints: 2</span>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">EventEmitter</span><span class="hl-1">, </span><span class="hl-4">listenerCount</span><span class="hl-1"> } = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEmitter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {});</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {});</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-5">listenerCount</span><span class="hl-1">(</span><span class="hl-0">myEmitter</span><span class="hl-1">, </span><span class="hl-6">'event'</span><span class="hl-1">));</span><br/><span class="hl-7">// Prints: 2</span>
|
||||
</code><button>Copy</button></pre>
|
||||
|
||||
<h3>Since</h3><p>v0.9.12</p>
|
||||
|
|
@ -721,14 +721,14 @@ event target. This is useful for debugging and diagnostic purposes.</p>
|
|||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||||
<li class="tsd-signature tsd-anchor-link" id="on-2.on-3"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#on-2.on-3" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> { </span><span class="hl-4">on</span><span class="hl-0">, </span><span class="hl-4">EventEmitter</span><span class="hl-0"> } = </span><span class="hl-5">require</span><span class="hl-0">(</span><span class="hl-6">'events'</span><span class="hl-0">);</span><br/><br/><span class="hl-0">(</span><span class="hl-3">async</span><span class="hl-0"> () </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">ee</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-0"> </span><span class="hl-7">// Emit later on</span><br/><span class="hl-0"> </span><span class="hl-1">process</span><span class="hl-0">.</span><span class="hl-5">nextTick</span><span class="hl-0">(() </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">ee</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'foo'</span><span class="hl-0">, </span><span class="hl-6">'bar'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-1">ee</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'foo'</span><span class="hl-0">, </span><span class="hl-2">42</span><span class="hl-0">);</span><br/><span class="hl-0"> });</span><br/><br/><span class="hl-0"> </span><span class="hl-8">for</span><span class="hl-0"> </span><span class="hl-8">await</span><span class="hl-0"> (</span><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">event</span><span class="hl-0"> </span><span class="hl-3">of</span><span class="hl-0"> </span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-1">ee</span><span class="hl-0">, </span><span class="hl-6">'foo'</span><span class="hl-0">)) {</span><br/><span class="hl-0"> </span><span class="hl-7">// The execution of this inner block is synchronous and it</span><br/><span class="hl-0"> </span><span class="hl-7">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-0"> </span><span class="hl-7">// if concurrent execution is required.</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-1">event</span><span class="hl-0">); </span><span class="hl-7">// prints ['bar'] [42]</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> </span><span class="hl-7">// Unreachable here</span><br/><span class="hl-0">})();</span>
|
||||
<div class="tsd-comment tsd-typography"><pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">on</span><span class="hl-1">, </span><span class="hl-4">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-1">(</span><span class="hl-3">async</span><span class="hl-1"> () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-7">// Emit later on</span><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-5">nextTick</span><span class="hl-1">(() </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, </span><span class="hl-6">'bar'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, </span><span class="hl-2">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-8">for</span><span class="hl-1"> </span><span class="hl-8">await</span><span class="hl-1"> (</span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">event</span><span class="hl-1"> </span><span class="hl-3">of</span><span class="hl-1"> </span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-6">'foo'</span><span class="hl-1">)) {</span><br/><span class="hl-1"> </span><span class="hl-7">// The execution of this inner block is synchronous and it</span><br/><span class="hl-1"> </span><span class="hl-7">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-1"> </span><span class="hl-7">// if concurrent execution is required.</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">); </span><span class="hl-7">// prints ['bar'] [42]</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-7">// Unreachable here</span><br/><span class="hl-1">})();</span>
|
||||
</code><button>Copy</button></pre>
|
||||
<p>Returns an <code>AsyncIterator</code> that iterates <code>eventName</code> events. It will throw
|
||||
if the <code>EventEmitter</code> emits <code>'error'</code>. It removes all listeners when
|
||||
exiting the loop. The <code>value</code> returned by each iteration is an array
|
||||
composed of the emitted event arguments.</p>
|
||||
<p>An <code>AbortSignal</code> can be used to cancel waiting on events:</p>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> { </span><span class="hl-4">on</span><span class="hl-0">, </span><span class="hl-4">EventEmitter</span><span class="hl-0"> } = </span><span class="hl-5">require</span><span class="hl-0">(</span><span class="hl-6">'events'</span><span class="hl-0">);</span><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">ac</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">AbortController</span><span class="hl-0">();</span><br/><br/><span class="hl-0">(</span><span class="hl-3">async</span><span class="hl-0"> () </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">ee</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-0"> </span><span class="hl-7">// Emit later on</span><br/><span class="hl-0"> </span><span class="hl-1">process</span><span class="hl-0">.</span><span class="hl-5">nextTick</span><span class="hl-0">(() </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">ee</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'foo'</span><span class="hl-0">, </span><span class="hl-6">'bar'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-1">ee</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'foo'</span><span class="hl-0">, </span><span class="hl-2">42</span><span class="hl-0">);</span><br/><span class="hl-0"> });</span><br/><br/><span class="hl-0"> </span><span class="hl-8">for</span><span class="hl-0"> </span><span class="hl-8">await</span><span class="hl-0"> (</span><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">event</span><span class="hl-0"> </span><span class="hl-3">of</span><span class="hl-0"> </span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-1">ee</span><span class="hl-0">, </span><span class="hl-6">'foo'</span><span class="hl-0">, { </span><span class="hl-1">signal:</span><span class="hl-0"> </span><span class="hl-1">ac</span><span class="hl-0">.</span><span class="hl-1">signal</span><span class="hl-0"> })) {</span><br/><span class="hl-0"> </span><span class="hl-7">// The execution of this inner block is synchronous and it</span><br/><span class="hl-0"> </span><span class="hl-7">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-0"> </span><span class="hl-7">// if concurrent execution is required.</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-1">event</span><span class="hl-0">); </span><span class="hl-7">// prints ['bar'] [42]</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> </span><span class="hl-7">// Unreachable here</span><br/><span class="hl-0">})();</span><br/><br/><span class="hl-1">process</span><span class="hl-0">.</span><span class="hl-5">nextTick</span><span class="hl-0">(() </span><span class="hl-3">=></span><span class="hl-0"> </span><span class="hl-1">ac</span><span class="hl-0">.</span><span class="hl-5">abort</span><span class="hl-0">());</span>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">on</span><span class="hl-1">, </span><span class="hl-4">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ac</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">AbortController</span><span class="hl-1">();</span><br/><br/><span class="hl-1">(</span><span class="hl-3">async</span><span class="hl-1"> () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-7">// Emit later on</span><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-5">nextTick</span><span class="hl-1">(() </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, </span><span class="hl-6">'bar'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, </span><span class="hl-2">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-8">for</span><span class="hl-1"> </span><span class="hl-8">await</span><span class="hl-1"> (</span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">event</span><span class="hl-1"> </span><span class="hl-3">of</span><span class="hl-1"> </span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-6">'foo'</span><span class="hl-1">, { </span><span class="hl-0">signal:</span><span class="hl-1"> </span><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-0">signal</span><span class="hl-1"> })) {</span><br/><span class="hl-1"> </span><span class="hl-7">// The execution of this inner block is synchronous and it</span><br/><span class="hl-1"> </span><span class="hl-7">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-1"> </span><span class="hl-7">// if concurrent execution is required.</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">); </span><span class="hl-7">// prints ['bar'] [42]</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-7">// Unreachable here</span><br/><span class="hl-1">})();</span><br/><br/><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-5">nextTick</span><span class="hl-1">(() </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-5">abort</span><span class="hl-1">());</span>
|
||||
</code><button>Copy</button></pre>
|
||||
|
||||
<h3>Since</h3><p>v13.6.0, v12.16.0</p>
|
||||
|
|
@ -760,15 +760,15 @@ The <code>Promise</code> will resolve with an array of all the arguments emitted
|
|||
given event.</p>
|
||||
<p>This method is intentionally generic and works with the web platform <a href="https://dom.spec.whatwg.org/#interface-eventtarget">EventTarget</a> interface, which has no special<code>'error'</code> event
|
||||
semantics and does not listen to the <code>'error'</code> event.</p>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> { </span><span class="hl-4">once</span><span class="hl-0">, </span><span class="hl-4">EventEmitter</span><span class="hl-0"> } = </span><span class="hl-5">require</span><span class="hl-0">(</span><span class="hl-6">'events'</span><span class="hl-0">);</span><br/><br/><span class="hl-3">async</span><span class="hl-0"> </span><span class="hl-3">function</span><span class="hl-0"> </span><span class="hl-5">run</span><span class="hl-0">() {</span><br/><span class="hl-0"> </span><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">ee</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-0"> </span><span class="hl-1">process</span><span class="hl-0">.</span><span class="hl-5">nextTick</span><span class="hl-0">(() </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">ee</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'myevent'</span><span class="hl-0">, </span><span class="hl-2">42</span><span class="hl-0">);</span><br/><span class="hl-0"> });</span><br/><br/><span class="hl-0"> </span><span class="hl-3">const</span><span class="hl-0"> [</span><span class="hl-4">value</span><span class="hl-0">] = </span><span class="hl-8">await</span><span class="hl-0"> </span><span class="hl-5">once</span><span class="hl-0">(</span><span class="hl-1">ee</span><span class="hl-0">, </span><span class="hl-6">'myevent'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-1">value</span><span class="hl-0">);</span><br/><br/><span class="hl-0"> </span><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">err</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">Error</span><span class="hl-0">(</span><span class="hl-6">'kaboom'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-1">process</span><span class="hl-0">.</span><span class="hl-5">nextTick</span><span class="hl-0">(() </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">ee</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'error'</span><span class="hl-0">, </span><span class="hl-1">err</span><span class="hl-0">);</span><br/><span class="hl-0"> });</span><br/><br/><span class="hl-0"> </span><span class="hl-8">try</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-8">await</span><span class="hl-0"> </span><span class="hl-5">once</span><span class="hl-0">(</span><span class="hl-1">ee</span><span class="hl-0">, </span><span class="hl-6">'myevent'</span><span class="hl-0">);</span><br/><span class="hl-0"> } </span><span class="hl-8">catch</span><span class="hl-0"> (</span><span class="hl-1">err</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'error happened'</span><span class="hl-0">, </span><span class="hl-1">err</span><span class="hl-0">);</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-5">run</span><span class="hl-0">();</span>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">once</span><span class="hl-1">, </span><span class="hl-4">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-3">async</span><span class="hl-1"> </span><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-5">run</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-5">nextTick</span><span class="hl-1">(() </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'myevent'</span><span class="hl-1">, </span><span class="hl-2">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> [</span><span class="hl-4">value</span><span class="hl-1">] = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-6">'myevent'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">value</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">err</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">(</span><span class="hl-6">'kaboom'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-5">nextTick</span><span class="hl-1">(() </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'error'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-8">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-6">'myevent'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-8">catch</span><span class="hl-1"> (</span><span class="hl-0">err</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'error happened'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">run</span><span class="hl-1">();</span>
|
||||
</code><button>Copy</button></pre>
|
||||
<p>The special handling of the <code>'error'</code> event is only used when <code>events.once()</code>is used to wait for another event. If <code>events.once()</code> is used to wait for the
|
||||
'<code>error'</code> event itself, then it is treated as any other kind of event without
|
||||
special handling:</p>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> { </span><span class="hl-4">EventEmitter</span><span class="hl-0">, </span><span class="hl-4">once</span><span class="hl-0"> } = </span><span class="hl-5">require</span><span class="hl-0">(</span><span class="hl-6">'events'</span><span class="hl-0">);</span><br/><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">ee</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-5">once</span><span class="hl-0">(</span><span class="hl-1">ee</span><span class="hl-0">, </span><span class="hl-6">'error'</span><span class="hl-0">)</span><br/><span class="hl-0"> .</span><span class="hl-5">then</span><span class="hl-0">(([</span><span class="hl-1">err</span><span class="hl-0">]) </span><span class="hl-3">=></span><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'ok'</span><span class="hl-0">, </span><span class="hl-1">err</span><span class="hl-0">.</span><span class="hl-1">message</span><span class="hl-0">))</span><br/><span class="hl-0"> .</span><span class="hl-5">catch</span><span class="hl-0">((</span><span class="hl-1">err</span><span class="hl-0">) </span><span class="hl-3">=></span><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'error'</span><span class="hl-0">, </span><span class="hl-1">err</span><span class="hl-0">.</span><span class="hl-1">message</span><span class="hl-0">));</span><br/><br/><span class="hl-1">ee</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'error'</span><span class="hl-0">, </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">Error</span><span class="hl-0">(</span><span class="hl-6">'boom'</span><span class="hl-0">));</span><br/><br/><span class="hl-7">// Prints: ok boom</span>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">EventEmitter</span><span class="hl-1">, </span><span class="hl-4">once</span><span class="hl-1"> } = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-6">'error'</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-5">then</span><span class="hl-1">(([</span><span class="hl-0">err</span><span class="hl-1">]) </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'ok'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">.</span><span class="hl-0">message</span><span class="hl-1">))</span><br/><span class="hl-1"> .</span><span class="hl-5">catch</span><span class="hl-1">((</span><span class="hl-0">err</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'error'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">.</span><span class="hl-0">message</span><span class="hl-1">));</span><br/><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'error'</span><span class="hl-1">, </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">(</span><span class="hl-6">'boom'</span><span class="hl-1">));</span><br/><br/><span class="hl-7">// Prints: ok boom</span>
|
||||
</code><button>Copy</button></pre>
|
||||
<p>An <code>AbortSignal</code> can be used to cancel waiting for the event:</p>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> { </span><span class="hl-4">EventEmitter</span><span class="hl-0">, </span><span class="hl-4">once</span><span class="hl-0"> } = </span><span class="hl-5">require</span><span class="hl-0">(</span><span class="hl-6">'events'</span><span class="hl-0">);</span><br/><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">ee</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">ac</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">AbortController</span><span class="hl-0">();</span><br/><br/><span class="hl-3">async</span><span class="hl-0"> </span><span class="hl-3">function</span><span class="hl-0"> </span><span class="hl-5">foo</span><span class="hl-0">(</span><span class="hl-1">emitter</span><span class="hl-0">, </span><span class="hl-1">event</span><span class="hl-0">, </span><span class="hl-1">signal</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-8">try</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-8">await</span><span class="hl-0"> </span><span class="hl-5">once</span><span class="hl-0">(</span><span class="hl-1">emitter</span><span class="hl-0">, </span><span class="hl-1">event</span><span class="hl-0">, { </span><span class="hl-1">signal</span><span class="hl-0"> });</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">log</span><span class="hl-0">(</span><span class="hl-6">'event emitted!'</span><span class="hl-0">);</span><br/><span class="hl-0"> } </span><span class="hl-8">catch</span><span class="hl-0"> (</span><span class="hl-1">error</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-8">if</span><span class="hl-0"> (</span><span class="hl-1">error</span><span class="hl-0">.</span><span class="hl-1">name</span><span class="hl-0"> === </span><span class="hl-6">'AbortError'</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">error</span><span class="hl-0">(</span><span class="hl-6">'Waiting for the event was canceled!'</span><span class="hl-0">);</span><br/><span class="hl-0"> } </span><span class="hl-8">else</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">console</span><span class="hl-0">.</span><span class="hl-5">error</span><span class="hl-0">(</span><span class="hl-6">'There was an error'</span><span class="hl-0">, </span><span class="hl-1">error</span><span class="hl-0">.</span><span class="hl-1">message</span><span class="hl-0">);</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-5">foo</span><span class="hl-0">(</span><span class="hl-1">ee</span><span class="hl-0">, </span><span class="hl-6">'foo'</span><span class="hl-0">, </span><span class="hl-1">ac</span><span class="hl-0">.</span><span class="hl-1">signal</span><span class="hl-0">);</span><br/><span class="hl-1">ac</span><span class="hl-0">.</span><span class="hl-5">abort</span><span class="hl-0">(); </span><span class="hl-7">// Abort waiting for the event</span><br/><span class="hl-1">ee</span><span class="hl-0">.</span><span class="hl-5">emit</span><span class="hl-0">(</span><span class="hl-6">'foo'</span><span class="hl-0">); </span><span class="hl-7">// Prints: Waiting for the event was canceled!</span>
|
||||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">EventEmitter</span><span class="hl-1">, </span><span class="hl-4">once</span><span class="hl-1"> } = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ac</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">AbortController</span><span class="hl-1">();</span><br/><br/><span class="hl-3">async</span><span class="hl-1"> </span><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-5">foo</span><span class="hl-1">(</span><span class="hl-0">emitter</span><span class="hl-1">, </span><span class="hl-0">event</span><span class="hl-1">, </span><span class="hl-0">signal</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-8">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-0">emitter</span><span class="hl-1">, </span><span class="hl-0">event</span><span class="hl-1">, { </span><span class="hl-0">signal</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'event emitted!'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-8">catch</span><span class="hl-1"> (</span><span class="hl-0">error</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-8">if</span><span class="hl-1"> (</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-6">'AbortError'</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">error</span><span class="hl-1">(</span><span class="hl-6">'Waiting for the event was canceled!'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-8">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">error</span><span class="hl-1">(</span><span class="hl-6">'There was an error'</span><span class="hl-1">, </span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">message</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">foo</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-6">'foo'</span><span class="hl-1">, </span><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-0">signal</span><span class="hl-1">);</span><br/><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-5">abort</span><span class="hl-1">(); </span><span class="hl-7">// Abort waiting for the event</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">); </span><span class="hl-7">// Prints: Waiting for the event was canceled!</span>
|
||||
</code><button>Copy</button></pre>
|
||||
|
||||
<h3>Since</h3><p>v11.13.0, v10.16.0</p>
|
||||
|
|
@ -806,7 +806,7 @@ special handling:</p>
|
|||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||||
<li class="tsd-signature tsd-anchor-link" id="setMaxListeners-2.setMaxListeners-3"><span class="tsd-kind-call-signature">set<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">n</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">eventTargets</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setMaxListeners-2.setMaxListeners-3" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography"><pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-4">setMaxListeners</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">EventEmitter</span><br/><span class="hl-0">} = </span><span class="hl-5">require</span><span class="hl-0">(</span><span class="hl-6">'events'</span><span class="hl-0">);</span><br/><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">target</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventTarget</span><span class="hl-0">();</span><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">emitter</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-5">setMaxListeners</span><span class="hl-0">(</span><span class="hl-2">5</span><span class="hl-0">, </span><span class="hl-1">target</span><span class="hl-0">, </span><span class="hl-1">emitter</span><span class="hl-0">);</span>
|
||||
<div class="tsd-comment tsd-typography"><pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">setMaxListeners</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><br/><span class="hl-1">} = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">target</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventTarget</span><span class="hl-1">();</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">emitter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-5">setMaxListeners</span><span class="hl-1">(</span><span class="hl-2">5</span><span class="hl-1">, </span><span class="hl-0">target</span><span class="hl-1">, </span><span class="hl-0">emitter</span><span class="hl-1">);</span>
|
||||
</code><button>Copy</button></pre>
|
||||
|
||||
<h3>Since</h3><p>v15.4.0</p>
|
||||
|
|
@ -1044,6 +1044,7 @@ special handling:</p>
|
|||
<li><a href="../functions/Network.Contracts.getInstance.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Instance</span></a></li>
|
||||
<li><a href="../functions/Network.Contracts.getProxy.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Proxy</span></a></li>
|
||||
<li><a href="../functions/Network.Contracts.getRegistry.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Registry</span></a></li>
|
||||
<li><a href="../functions/Network.Contracts.getRouter.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Router</span></a></li>
|
||||
<li><a href="../functions/Network.Contracts.getToken.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Token</span></a></li>
|
||||
<li><a href="../functions/Network.Contracts.getTornToken.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Torn<wbr/>Token</span></a></li></ul></div></details></li>
|
||||
<li>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue