@vonage/media-processor 1.0.1 → 1.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/dist/docs/assets/highlight.css +30 -16
  2. package/dist/docs/assets/search.js +1 -1
  3. package/dist/docs/classes/MediaProcessor.html +95 -5
  4. package/dist/docs/classes/MediaProcessorConnector.html +1 -1
  5. package/dist/docs/index.html +1 -1
  6. package/dist/docs/modules.html +22 -5
  7. package/dist/media-processor.es.js +452 -14
  8. package/dist/media-processor.umd.js +3 -2
  9. package/dist/types/main.d.ts +3 -2
  10. package/dist/types/src/core/MediaProcessor.d.ts +21 -2
  11. package/dist/types/src/core/pipeline.d.ts +81 -3
  12. package/dist/types/src/telemetry/Reporter.d.ts +5 -1
  13. package/dist/types/src/utils/Tools.d.ts +1 -0
  14. package/package.json +3 -2
package/dist/docs/classes/MediaProcessor.html CHANGED
@@ -1,10 +1,92 @@
1
1
  <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MediaProcessor | @vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@vonage/media-processor</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@vonage/media-processor</a></li><li><a href="MediaProcessor.html">MediaProcessor</a></li></ul><h1>Class MediaProcessor</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
- <p>Media processor class holding and running the media processing logic.</p>
3
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-0"> </span><span class="hl-1">let</span><span class="hl-0"> </span><span class="hl-4">mediaProcessor</span><span class="hl-0">: </span><span class="hl-3">MediaProcessor</span><span class="hl-0"> = </span><span class="hl-1">new</span><span class="hl-0"> </span><span class="hl-6">MediaProcessor</span><span class="hl-0">();</span><br/><span class="hl-0"> </span><span class="hl-1">let</span><span class="hl-0"> </span><span class="hl-4">transformers</span><span class="hl-0">: </span><span class="hl-3">Array</span><span class="hl-0">&lt;</span><span class="hl-3">Transformer</span><span class="hl-0">&gt; = [];</span><br/><span class="hl-0"> </span><span class="hl-4">transformers</span><span class="hl-0">.</span><span class="hl-6">push</span><span class="hl-0">(</span><span class="hl-1">new</span><span class="hl-0"> </span><span class="hl-6">CanvasTransform</span><span class="hl-0">());</span><br/><span class="hl-0"> </span><span class="hl-4">mediaProcessor</span><span class="hl-0">.</span><span class="hl-6">setTransformers</span><span class="hl-0">(</span><span class="hl-4">transformers</span><span class="hl-0">);</span>
2
+ <p>Media processor class holding and running the media processing logic.
3
+ The class implements an async event emitter pattern</p>
4
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-0"> </span><span class="hl-6">let</span><span class="hl-0"> </span><span class="hl-5">mediaProcessor</span><span class="hl-0">: </span><span class="hl-8">MediaProcessor</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">MediaProcessor</span><span class="hl-0">();</span><br/><span class="hl-0"> </span><span class="hl-6">let</span><span class="hl-0"> </span><span class="hl-5">transformers</span><span class="hl-0">: </span><span class="hl-8">Array</span><span class="hl-0">&lt;</span><span class="hl-8">Transformer</span><span class="hl-0">&gt; = [];</span><br/><span class="hl-0"> </span><span class="hl-5">transformers</span><span class="hl-0">.</span><span class="hl-4">push</span><span class="hl-0">(</span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">CanvasTransform</span><span class="hl-0">());</span><br/><span class="hl-0"> </span><span class="hl-5">mediaProcessor</span><span class="hl-0">.</span><span class="hl-4">setTransformers</span><span class="hl-0">(</span><span class="hl-5">transformers</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">mediaProcessor</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-3">&#39;error&#39;</span><span class="hl-0">,(</span><span class="hl-5">ErrorData</span><span class="hl-0"> </span><span class="hl-6">=&gt;</span><span class="hl-0"> {}))</span><br/><span class="hl-0"> </span><span class="hl-5">mediaProcessor</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-3">&#39;warn&#39;</span><span class="hl-0">,(</span><span class="hl-5">WarnData</span><span class="hl-0"> </span><span class="hl-6">=&gt;</span><span class="hl-0"> {}))</span>
4
5
  </code></pre>
5
- </dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">MediaProcessor</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="MediaProcessor.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessor.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessor.html#setTransformers" class="tsd-kind-icon">set<wbr/>Transformers</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessor.html#transform" class="tsd-kind-icon">transform</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Media<wbr/>Processor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MediaProcessor.html" class="tsd-signature-type" data-tsd-kind="Class">MediaProcessor</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="MediaProcessor.html" class="tsd-signature-type" data-tsd-kind="Class">MediaProcessor</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link">destroy<a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
6
+ </dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Emittery</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">MediaProcessor</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="MediaProcessor.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#debug" class="tsd-kind-icon">debug</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MediaProcessor.html#isDebugEnabled" class="tsd-kind-icon">is<wbr/>Debug<wbr/>Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MediaProcessor.html#listenerAdded" class="tsd-kind-icon">listener<wbr/>Added</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MediaProcessor.html#listenerRemoved" class="tsd-kind-icon">listener<wbr/>Removed</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#anyEvent" class="tsd-kind-icon">any<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#bindMethods" class="tsd-kind-icon">bind<wbr/>Methods</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#clearListeners" class="tsd-kind-icon">clear<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessor.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#emitSerial" class="tsd-kind-icon">emit<wbr/>Serial</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#events" class="tsd-kind-icon">events</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#listenerCount" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#offAny" class="tsd-kind-icon">off<wbr/>Any</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#onAny" class="tsd-kind-icon">on<wbr/>Any</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessor.html#setTrackExpectedRate" class="tsd-kind-icon">set<wbr/>Track<wbr/>Expected<wbr/>Rate</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessor.html#setTransformers" class="tsd-kind-icon">set<wbr/>Transformers</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessor.html#transform" class="tsd-kind-icon">transform</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MediaProcessor.html#mixin" class="tsd-kind-icon">mixin</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Media<wbr/>Processor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MediaProcessor.html" class="tsd-signature-type" data-tsd-kind="Class">MediaProcessor</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides Emittery&lt;EventDataMap&gt;.constructor</p></aside><h4 class="tsd-returns-title">Returns <a href="MediaProcessor.html" class="tsd-signature-type" data-tsd-kind="Class">MediaProcessor</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="debug" class="tsd-anchor"></a><h3 class="tsd-anchor-link">debug<a href="#debug" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">debug<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DebugOptions</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><p>Inherited from Emittery.debug</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
7
+ <p>Debugging options for the current instance.</p>
8
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="isDebugEnabled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> is<wbr/>Debug<wbr/>Enabled<a href="#isDebugEnabled" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">is<wbr/>Debug<wbr/>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from Emittery.isDebugEnabled</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
9
+ <p>Toggle debug mode for all instances.</p>
10
+ </div><div><p>Default: <code>true</code> if the <code>DEBUG</code> environment variable is set to <code>emittery</code> or <code>*</code>, otherwise <code>false</code>.</p>
11
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-9">import</span><span class="hl-0"> </span><span class="hl-5">Emittery</span><span class="hl-0"> = </span><span class="hl-9">require</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-5">Emittery</span><span class="hl-0">.</span><span class="hl-5">isDebugEnabled</span><span class="hl-0"> = </span><span class="hl-6">true</span><span class="hl-0">;</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">emitter1</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">Emittery</span><span class="hl-0">({</span><span class="hl-5">debug:</span><span class="hl-0"> {</span><span class="hl-5">name:</span><span class="hl-0"> </span><span class="hl-3">&#39;myEmitter1&#39;</span><span class="hl-0">}});</span><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">emitter2</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">Emittery</span><span class="hl-0">({</span><span class="hl-5">debug:</span><span class="hl-0"> {</span><span class="hl-5">name:</span><span class="hl-0"> </span><span class="hl-3">&#39;myEmitter2&#39;</span><span class="hl-0">}});</span><br/><br/><span class="hl-5">emitter1</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-3">&#39;test&#39;</span><span class="hl-0">, </span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-10">// …</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-5">emitter2</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-3">&#39;otherTest&#39;</span><span class="hl-0">, </span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-10">// …</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-5">emitter1</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;test&#39;</span><span class="hl-0">);</span><br/><span class="hl-10">//=&gt; [16:43:20.417][emittery:subscribe][myEmitter1] Event Name: test</span><br/><span class="hl-10">// data: undefined</span><br/><br/><span class="hl-5">emitter2</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;otherTest&#39;</span><span class="hl-0">);</span><br/><span class="hl-10">//=&gt; [16:43:20.417][emittery:subscribe][myEmitter2] Event Name: otherTest</span><br/><span class="hl-10">// data: undefined</span>
12
+ </code></pre>
13
+ </dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="listenerAdded" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> listener<wbr/>Added<a href="#listenerAdded" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">listener<wbr/>Added<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">listenerAdded</span></div><aside class="tsd-sources"><p>Inherited from Emittery.listenerAdded</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
14
+ <p>Fires when an event listener was added.</p>
15
+ </div><div><p>An object with <code>listener</code> and <code>eventName</code> (if <code>on</code> or <code>off</code> was used) is provided as event data.</p>
16
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-9">import</span><span class="hl-0"> </span><span class="hl-5">Emittery</span><span class="hl-0"> = </span><span class="hl-9">require</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">emitter</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">Emittery</span><span class="hl-0">();</span><br/><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-5">Emittery</span><span class="hl-0">.</span><span class="hl-5">listenerAdded</span><span class="hl-0">, ({</span><span class="hl-5">listener</span><span class="hl-0">, </span><span class="hl-5">eventName</span><span class="hl-0">}) </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-5">listener</span><span class="hl-0">);</span><br/><span class="hl-10">//=&gt; data =&gt; {}</span><br/><br/><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-5">eventName</span><span class="hl-0">);</span><br/><span class="hl-10">//=&gt; &#39;🦄&#39;</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-10">// Handle data</span><br/><span class="hl-0">});</span>
17
+ </code></pre>
18
+ </dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="listenerRemoved" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> listener<wbr/>Removed<a href="#listenerRemoved" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">listener<wbr/>Removed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">listenerRemoved</span></div><aside class="tsd-sources"><p>Inherited from Emittery.listenerRemoved</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
19
+ <p>Fires when an event listener was removed.</p>
20
+ </div><div><p>An object with <code>listener</code> and <code>eventName</code> (if <code>on</code> or <code>off</code> was used) is provided as event data.</p>
21
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-9">import</span><span class="hl-0"> </span><span class="hl-5">Emittery</span><span class="hl-0"> = </span><span class="hl-9">require</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">emitter</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">Emittery</span><span class="hl-0">();</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">off</span><span class="hl-0"> = </span><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-10">// Handle data</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-5">Emittery</span><span class="hl-0">.</span><span class="hl-5">listenerRemoved</span><span class="hl-0">, ({</span><span class="hl-5">listener</span><span class="hl-0">, </span><span class="hl-5">eventName</span><span class="hl-0">}) </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-5">listener</span><span class="hl-0">);</span><br/><span class="hl-10">//=&gt; data =&gt; {}</span><br/><br/><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-5">eventName</span><span class="hl-0">);</span><br/><span class="hl-10">//=&gt; &#39;🦄&#39;</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-4">off</span><span class="hl-0">();</span>
22
+ </code></pre>
23
+ </dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="anyEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link">any<wbr/>Event<a href="#anyEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">any<wbr/>Event<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">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#WarnData" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ErrorData" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorData</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.anyEvent</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
24
+ <p>Get an async iterator which buffers a tuple of an event name and data each time an event is emitted.</p>
25
+ </div><div><p>Call <code>return()</code> on the iterator to remove the subscription.</p>
26
+ <p>In the same way as for <code>events</code>, you can subscribe by using the <code>for await</code> statement.</p>
27
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-9">import</span><span class="hl-0"> </span><span class="hl-5">Emittery</span><span class="hl-0"> = </span><span class="hl-9">require</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">emitter</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">Emittery</span><span class="hl-0">();</span><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">iterator</span><span class="hl-0"> = </span><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">anyEvent</span><span class="hl-0">();</span><br/><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🌈1&#39;</span><span class="hl-0">); </span><span class="hl-10">// Buffered</span><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🌟&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-0">); </span><span class="hl-10">// Buffered</span><br/><br/><span class="hl-5">iterator</span><span class="hl-0">.</span><span class="hl-4">next</span><span class="hl-0">()</span><br/><span class="hl-0">.</span><span class="hl-4">then</span><span class="hl-0">(({</span><span class="hl-5">value</span><span class="hl-0">, </span><span class="hl-5">done</span><span class="hl-0">}) </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-10">// done is false</span><br/><span class="hl-10">// value is [&#39;🦄&#39;, &#39;🌈1&#39;]</span><br/><span class="hl-9">return</span><span class="hl-0"> </span><span class="hl-5">iterator</span><span class="hl-0">.</span><span class="hl-4">next</span><span class="hl-0">();</span><br/><span class="hl-0">})</span><br/><span class="hl-0">.</span><span class="hl-4">then</span><span class="hl-0">(({</span><span class="hl-5">value</span><span class="hl-0">, </span><span class="hl-5">done</span><span class="hl-0">}) </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-10">// done is false</span><br/><span class="hl-10">// value is [&#39;🌟&#39;, &#39;🌈2&#39;]</span><br/><span class="hl-10">// revoke subscription</span><br/><span class="hl-9">return</span><span class="hl-0"> </span><span class="hl-5">iterator</span><span class="hl-0">.</span><span class="hl-4">return</span><span class="hl-0">();</span><br/><span class="hl-0">})</span><br/><span class="hl-0">.</span><span class="hl-4">then</span><span class="hl-0">(({</span><span class="hl-5">done</span><span class="hl-0">}) </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-10">// done is true</span><br/><span class="hl-0">});</span>
28
+ </code></pre>
29
+ </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#WarnData" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ErrorData" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorData</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="bindMethods" class="tsd-anchor"></a><h3 class="tsd-anchor-link">bind<wbr/>Methods<a href="#bindMethods" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">bind<wbr/>Methods<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span>, methodNames<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.bindMethods</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
30
+ <p>Bind the given <code>methodNames</code>, or all <code>Emittery</code> methods if <code>methodNames</code> is not defined, into the <code>target</code> object.</p>
31
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-9">import</span><span class="hl-0"> </span><span class="hl-5">Emittery</span><span class="hl-0"> = </span><span class="hl-9">require</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">object</span><span class="hl-0"> = {};</span><br/><br/><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">Emittery</span><span class="hl-0">().</span><span class="hl-4">bindMethods</span><span class="hl-0">(</span><span class="hl-5">object</span><span class="hl-0">);</span><br/><br/><span class="hl-5">object</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;event&#39;</span><span class="hl-0">);</span>
32
+ </code></pre>
33
+ </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> methodNames: <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a id="clearListeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link">clear<wbr/>Listeners<a href="#clearListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">clear<wbr/>Listeners<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.clearListeners</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
34
+ <p>Clear all event listeners on the instance.</p>
35
+ </div><div><p>If <code>eventName</code> is given, only the listeners for that event are cleared.</p>
36
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link">destroy<a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
6
37
  <p>Stops running the tranformation logic performed by the media processor instance.</p>
7
- </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setTransformers" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Transformers<a href="#setTransformers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Transformers<span class="tsd-signature-symbol">(</span>transformers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transformer</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
38
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a id="emit" class="tsd-anchor"></a><h3 class="tsd-anchor-link">emit<a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span>, eventData<span class="tsd-signature-symbol">: </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.emit</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
39
+ <p>Trigger an event asynchronously, optionally with some data. Listeners are called in the order they were added, but executed concurrently.</p>
40
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>A promise that resolves when all the event listeners are done. <em>Done</em> meaning executed if synchronous or resolved when an async/promise-returning function. You usually wouldn&#39;t want to wait for this, but you could for example catch possible errors. If any of the listeners throw/reject, the returned promise will be rejected with the error, but the other listeners will not be affected.</p>
41
+ </div></li><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.emit</p></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span></h5></li><li><h5>eventData: <a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a id="emitSerial" class="tsd-anchor"></a><h3 class="tsd-anchor-link">emit<wbr/>Serial<a href="#emitSerial" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">emit<wbr/>Serial<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">emit<wbr/>Serial<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span>, eventData<span class="tsd-signature-symbol">: </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.emitSerial</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
42
+ <p>Same as <code>emit()</code>, but it waits for each listener to resolve before triggering the next one. This can be useful if your events depend on each other. Although ideally they should not. Prefer <code>emit()</code> whenever possible.</p>
43
+ </div><div><p>If any of the listeners throw/reject, the returned promise will be rejected with the error and the remaining listeners will <em>not</em> be called.</p>
44
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>A promise that resolves when all the event listeners are done.</p>
45
+ </div></li><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.emitSerial</p></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span></h5></li><li><h5>eventData: <a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a id="events" class="tsd-anchor"></a><h3 class="tsd-anchor-link">events<a href="#events" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">events<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</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">&lt;</span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.events</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
46
+ <p>Get an async iterator which buffers data each time an event is emitted.</p>
47
+ </div><div><p>Call <code>return()</code> on the iterator to remove the subscription.</p>
48
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-9">import</span><span class="hl-0"> </span><span class="hl-5">Emittery</span><span class="hl-0"> = </span><span class="hl-9">require</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">emitter</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">Emittery</span><span class="hl-0">();</span><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">iterator</span><span class="hl-0"> = </span><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">events</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🌈1&#39;</span><span class="hl-0">); </span><span class="hl-10">// Buffered</span><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-0">); </span><span class="hl-10">// Buffered</span><br/><br/><span class="hl-5">iterator</span><br/><span class="hl-0">.</span><span class="hl-4">next</span><span class="hl-0">()</span><br/><span class="hl-0">.</span><span class="hl-4">then</span><span class="hl-0">(({</span><span class="hl-5">value</span><span class="hl-0">, </span><span class="hl-5">done</span><span class="hl-0">}) </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-10">// done === false</span><br/><span class="hl-10">// value === &#39;🌈1&#39;</span><br/><span class="hl-9">return</span><span class="hl-0"> </span><span class="hl-5">iterator</span><span class="hl-0">.</span><span class="hl-4">next</span><span class="hl-0">();</span><br/><span class="hl-0">})</span><br/><span class="hl-0">.</span><span class="hl-4">then</span><span class="hl-0">(({</span><span class="hl-5">value</span><span class="hl-0">, </span><span class="hl-5">done</span><span class="hl-0">}) </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-10">// done === false</span><br/><span class="hl-10">// value === &#39;🌈2&#39;</span><br/><span class="hl-10">// Revoke subscription</span><br/><span class="hl-9">return</span><span class="hl-0"> </span><span class="hl-5">iterator</span><span class="hl-0">.</span><span class="hl-4">return</span><span class="hl-0">();</span><br/><span class="hl-0">})</span><br/><span class="hl-0">.</span><span class="hl-4">then</span><span class="hl-0">(({</span><span class="hl-5">done</span><span class="hl-0">}) </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-10">// done === true</span><br/><span class="hl-0">});</span>
49
+ </code></pre>
50
+ <p>In practice you would usually consume the events using the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of">for await</a> statement. In that case, to revoke the subscription simply break the loop.</p>
51
+ </dd><dt>example</dt><dd><pre><code><span class="hl-9">import</span><span class="hl-0"> </span><span class="hl-5">Emittery</span><span class="hl-0"> = </span><span class="hl-9">require</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">emitter</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">Emittery</span><span class="hl-0">();</span><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">iterator</span><span class="hl-0"> = </span><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">events</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🌈1&#39;</span><span class="hl-0">); </span><span class="hl-10">// Buffered</span><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-0">); </span><span class="hl-10">// Buffered</span><br/><br/><span class="hl-10">// In an async context.</span><br/><span class="hl-9">for</span><span class="hl-0"> </span><span class="hl-9">await</span><span class="hl-0"> (</span><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">data</span><span class="hl-0"> </span><span class="hl-6">of</span><span class="hl-0"> </span><span class="hl-5">iterator</span><span class="hl-0">) {</span><br/><span class="hl-9">if</span><span class="hl-0"> (</span><span class="hl-5">data</span><span class="hl-0"> === </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-0">) {</span><br/><span class="hl-9">break</span><span class="hl-0">; </span><span class="hl-10">// Revoke the subscription when we see the value `🌈2`.</span><br/><span class="hl-0">}</span><br/><span class="hl-0">}</span>
52
+ </code></pre>
53
+ <p>It accepts multiple event names.</p>
54
+ </dd><dt>example</dt><dd><pre><code><span class="hl-9">import</span><span class="hl-0"> </span><span class="hl-5">Emittery</span><span class="hl-0"> = </span><span class="hl-9">require</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">emitter</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">Emittery</span><span class="hl-0">();</span><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">iterator</span><span class="hl-0"> = </span><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">events</span><span class="hl-0">([</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-0">]);</span><br/><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🌈1&#39;</span><span class="hl-0">); </span><span class="hl-10">// Buffered</span><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-0">); </span><span class="hl-10">// Buffered</span><br/><br/><span class="hl-5">iterator</span><br/><span class="hl-0">.</span><span class="hl-4">next</span><span class="hl-0">()</span><br/><span class="hl-0">.</span><span class="hl-4">then</span><span class="hl-0">(({</span><span class="hl-5">value</span><span class="hl-0">, </span><span class="hl-5">done</span><span class="hl-0">}) </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-10">// done === false</span><br/><span class="hl-10">// value === &#39;🌈1&#39;</span><br/><span class="hl-9">return</span><span class="hl-0"> </span><span class="hl-5">iterator</span><span class="hl-0">.</span><span class="hl-4">next</span><span class="hl-0">();</span><br/><span class="hl-0">})</span><br/><span class="hl-0">.</span><span class="hl-4">then</span><span class="hl-0">(({</span><span class="hl-5">value</span><span class="hl-0">, </span><span class="hl-5">done</span><span class="hl-0">}) </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-10">// done === false</span><br/><span class="hl-10">// value === &#39;🌈2&#39;</span><br/><span class="hl-10">// Revoke subscription</span><br/><span class="hl-9">return</span><span class="hl-0"> </span><span class="hl-5">iterator</span><span class="hl-0">.</span><span class="hl-4">return</span><span class="hl-0">();</span><br/><span class="hl-0">})</span><br/><span class="hl-0">.</span><span class="hl-4">then</span><span class="hl-0">(({</span><span class="hl-5">done</span><span class="hl-0">}) </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-10">// done === true</span><br/><span class="hl-0">});</span>
55
+ </code></pre>
56
+ </dd></dl></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a id="listenerCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link">listener<wbr/>Count<a href="#listenerCount" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">listener<wbr/>Count<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.listenerCount</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
57
+ <p>The number of listeners for the <code>eventName</code> or all events if not specified.</p>
58
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a id="off" class="tsd-anchor"></a><h3 class="tsd-anchor-link">off<a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>eventData<span class="tsd-signature-symbol">: </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">_OmnipresentEventData</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.off</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
59
+ <p>Remove one or more event subscriptions.</p>
60
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-9">import</span><span class="hl-0"> </span><span class="hl-5">Emittery</span><span class="hl-0"> = </span><span class="hl-9">require</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">emitter</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">Emittery</span><span class="hl-0">();</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-4">listener</span><span class="hl-0"> = </span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-6">=&gt;</span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">);</span><br/><span class="hl-0">(</span><span class="hl-6">async</span><span class="hl-0"> () </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">([</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-0">], </span><span class="hl-5">listener</span><span class="hl-0">);</span><br/><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;a&#39;</span><span class="hl-0">);</span><br/><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;b&#39;</span><span class="hl-0">);</span><br/><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;c&#39;</span><span class="hl-0">);</span><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">off</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-5">listener</span><span class="hl-0">);</span><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">off</span><span class="hl-0">([</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-0">], </span><span class="hl-5">listener</span><span class="hl-0">);</span><br/><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;a&#39;</span><span class="hl-0">); </span><span class="hl-10">// nothing happens</span><br/><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;b&#39;</span><span class="hl-0">); </span><span class="hl-10">// nothing happens</span><br/><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;c&#39;</span><span class="hl-0">); </span><span class="hl-10">// nothing happens</span><br/><span class="hl-0">})();</span>
61
+ </code></pre>
62
+ </dd></dl></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type">_OmnipresentEventData</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>eventData<span class="tsd-signature-symbol">: </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">_OmnipresentEventData</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>eventData<span class="tsd-signature-symbol">: </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">_OmnipresentEventData</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventData: <a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">_OmnipresentEventData</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="offAny" class="tsd-anchor"></a><h3 class="tsd-anchor-link">off<wbr/>Any<a href="#offAny" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">off<wbr/>Any<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a>, eventData<span class="tsd-signature-symbol">: </span><a href="../modules.html#WarnData" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ErrorData" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.offAny</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
63
+ <p>Remove an <code>onAny</code> subscription.</p>
64
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>listener: <span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a>, eventData<span class="tsd-signature-symbol">: </span><a href="../modules.html#WarnData" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ErrorData" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a>, eventData<span class="tsd-signature-symbol">: </span><a href="../modules.html#WarnData" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ErrorData" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a></h5></li><li><h5>eventData: <a href="../modules.html#WarnData" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ErrorData" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorData</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a id="on" class="tsd-anchor"></a><h3 class="tsd-anchor-link">on<a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>eventData<span class="tsd-signature-symbol">: </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">_OmnipresentEventData</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">UnsubscribeFn</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.on</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
65
+ <p>Subscribe to one or more events.</p>
66
+ </div><div><p>Using the same listener multiple times for the same event will result in only one method call per emitted event.</p>
67
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-9">import</span><span class="hl-0"> </span><span class="hl-5">Emittery</span><span class="hl-0"> = </span><span class="hl-9">require</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">emitter</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">Emittery</span><span class="hl-0">();</span><br/><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">([</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-0">], </span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🌈&#39;</span><span class="hl-0">); </span><span class="hl-10">// log =&gt; &#39;🌈&#39; x2</span><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🍖&#39;</span><span class="hl-0">); </span><span class="hl-10">// log =&gt; &#39;🍖&#39;</span>
68
+ </code></pre>
69
+ </dd></dl></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type">_OmnipresentEventData</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>eventData<span class="tsd-signature-symbol">: </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">_OmnipresentEventData</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>eventData<span class="tsd-signature-symbol">: </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">_OmnipresentEventData</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventData: <a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">_OmnipresentEventData</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UnsubscribeFn</span></h4><div><p>An unsubscribe method.</p>
70
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="onAny" class="tsd-anchor"></a><h3 class="tsd-anchor-link">on<wbr/>Any<a href="#onAny" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">on<wbr/>Any<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a>, eventData<span class="tsd-signature-symbol">: </span><a href="../modules.html#WarnData" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ErrorData" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">UnsubscribeFn</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.onAny</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
71
+ <p>Subscribe to be notified about any event.</p>
72
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>listener: <span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a>, eventData<span class="tsd-signature-symbol">: </span><a href="../modules.html#WarnData" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ErrorData" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a>, eventData<span class="tsd-signature-symbol">: </span><a href="../modules.html#WarnData" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ErrorData" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a></h5></li><li><h5>eventData: <a href="../modules.html#WarnData" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ErrorData" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorData</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UnsubscribeFn</span></h4><div><p>A method to unsubscribe.</p>
73
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a id="once" class="tsd-anchor"></a><h3 class="tsd-anchor-link">once<a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">_OmnipresentEventData</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.once</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
74
+ <p>Subscribe to one or more events only once. It will be unsubscribed after the first
75
+ event.</p>
76
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-9">import</span><span class="hl-0"> </span><span class="hl-5">Emittery</span><span class="hl-0"> = </span><span class="hl-9">require</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">emitter</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">Emittery</span><span class="hl-0">();</span><br/><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">once</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">).</span><span class="hl-4">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">);</span><br/><span class="hl-10">//=&gt; &#39;🌈&#39;</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">once</span><span class="hl-0">([</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-0">]).</span><span class="hl-4">then</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0"> </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-5">data</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🌈&#39;</span><span class="hl-0">); </span><span class="hl-10">// Logs `🌈` twice</span><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-0">, </span><span class="hl-3">&#39;🍖&#39;</span><span class="hl-0">); </span><span class="hl-10">// Nothing happens</span>
77
+ </code></pre>
78
+ </dd></dl></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type">_OmnipresentEventData</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#EventDataMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">_OmnipresentEventData</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The event data when <code>eventName</code> is emitted.</p>
79
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setTrackExpectedRate" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Track<wbr/>Expected<wbr/>Rate<a href="#setTrackExpectedRate" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Track<wbr/>Expected<wbr/>Rate<span class="tsd-signature-symbol">(</span>trackExpectedRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
80
+ <p>Sets the expected rate of the track per second.
81
+ The media processor will use this number for calculating drops in the rate.
82
+ This could happen when the transformation will take more time than expected.
83
+ This will not cause an error, just warning to the client.
84
+ Mostly:
85
+ Video: 30 frames per second
86
+ Audio: 50 audio data per second for OPUS</p>
87
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>trackExpectedRate: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
88
+ <p>number holds the predicted track rate.</p>
89
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setTransformers" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Transformers<a href="#setTransformers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Transformers<span class="tsd-signature-symbol">(</span>transformers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transformer</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
8
90
  <p>Sets an array of transfromer instances that will be hold and ran by the media processor instance.</p>
9
91
  </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>transformers: <span class="tsd-signature-type">Transformer</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
10
92
  <p>An array of transformer instances.</p>
@@ -14,4 +96,12 @@
14
96
  <p>Readable stream associated to the media source being processed.</p>
15
97
  </div></div></li><li><h5>writable: <span class="tsd-signature-type">WritableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
16
98
  <p>Writable stream associated to the resulting media once processed.</p>
17
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="MediaProcessor.html" class="tsd-kind-icon">Media<wbr/>Processor</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="MediaProcessor.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessor.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessor.html#setTransformers" class="tsd-kind-icon">set<wbr/>Transformers</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessor.html#transform" class="tsd-kind-icon">transform</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
99
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="mixin" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> mixin<a href="#mixin" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">mixin<span class="tsd-signature-symbol">(</span>emitteryPropertyName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, methodNames<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>klass<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Emittery.mixin</p></aside><div class="tsd-comment tsd-typography"><div class="lead">
100
+ <p>In TypeScript, it returns a decorator which mixins <code>Emittery</code> as property <code>emitteryPropertyName</code> and <code>methodNames</code>, or all <code>Emittery</code> methods if <code>methodNames</code> is not defined, into the target class.</p>
101
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-9">import</span><span class="hl-0"> </span><span class="hl-5">Emittery</span><span class="hl-0"> = </span><span class="hl-9">require</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-0">@</span><span class="hl-5">Emittery</span><span class="hl-0">.</span><span class="hl-4">mixin</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">)</span><br/><span class="hl-6">class</span><span class="hl-0"> </span><span class="hl-8">MyClass</span><span class="hl-0"> {}</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">instance</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">MyClass</span><span class="hl-0">();</span><br/><br/><span class="hl-5">instance</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;event&#39;</span><span class="hl-0">);</span>
102
+ </code></pre>
103
+ </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitteryPropertyName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> methodNames: <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>klass<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-has-type-parameter tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>klass<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
104
+ <p>In TypeScript, it returns a decorator which mixins <code>Emittery</code> as property <code>emitteryPropertyName</code> and <code>methodNames</code>, or all <code>Emittery</code> methods if <code>methodNames</code> is not defined, into the target class.</p>
105
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-9">import</span><span class="hl-0"> </span><span class="hl-5">Emittery</span><span class="hl-0"> = </span><span class="hl-9">require</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">);</span><br/><br/><span class="hl-0">@</span><span class="hl-5">Emittery</span><span class="hl-0">.</span><span class="hl-4">mixin</span><span class="hl-0">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-0">)</span><br/><span class="hl-6">class</span><span class="hl-0"> </span><span class="hl-8">MyClass</span><span class="hl-0"> {}</span><br/><br/><span class="hl-6">const</span><span class="hl-0"> </span><span class="hl-7">instance</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">MyClass</span><span class="hl-0">();</span><br/><br/><span class="hl-5">instance</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-3">&#39;event&#39;</span><span class="hl-0">);</span>
106
+ </code></pre>
107
+ </dd></dl></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">new </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>klass: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4></li></ul></li></ul></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="MediaProcessor.html" class="tsd-kind-icon">Media<wbr/>Processor</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="MediaProcessor.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#debug" class="tsd-kind-icon">debug</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MediaProcessor.html#isDebugEnabled" class="tsd-kind-icon">is<wbr/>Debug<wbr/>Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MediaProcessor.html#listenerAdded" class="tsd-kind-icon">listener<wbr/>Added</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MediaProcessor.html#listenerRemoved" class="tsd-kind-icon">listener<wbr/>Removed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#anyEvent" class="tsd-kind-icon">any<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#bindMethods" class="tsd-kind-icon">bind<wbr/>Methods</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#clearListeners" class="tsd-kind-icon">clear<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessor.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#emitSerial" class="tsd-kind-icon">emit<wbr/>Serial</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#events" class="tsd-kind-icon">events</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#listenerCount" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#offAny" class="tsd-kind-icon">off<wbr/>Any</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#onAny" class="tsd-kind-icon">on<wbr/>Any</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="MediaProcessor.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessor.html#setTrackExpectedRate" class="tsd-kind-icon">set<wbr/>Track<wbr/>Expected<wbr/>Rate</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessor.html#setTransformers" class="tsd-kind-icon">set<wbr/>Transformers</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessor.html#transform" class="tsd-kind-icon">transform</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="MediaProcessor.html#mixin" class="tsd-kind-icon">mixin</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>