@vonage/media-processor 3.0.0-alpha.1 → 3.0.0-alpha.2

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 (46) hide show
  1. package/dist/docs/assets/hierarchy.js +1 -0
  2. package/dist/docs/assets/highlight.css +12 -5
  3. package/dist/docs/assets/icons.js +18 -0
  4. package/dist/docs/assets/icons.svg +1 -0
  5. package/dist/docs/assets/main.js +60 -52
  6. package/dist/docs/assets/navigation.js +1 -0
  7. package/dist/docs/assets/search.js +1 -1
  8. package/dist/docs/assets/style.css +1496 -1277
  9. package/dist/docs/classes/MediaProcessor.html +109 -95
  10. package/dist/docs/classes/MediaProcessorConnector.html +11 -7
  11. package/dist/docs/enums/ErrorFunction.html +8 -9
  12. package/dist/docs/enums/PipelineInfoData.html +14 -15
  13. package/dist/docs/enums/VonageSourceType.html +5 -5
  14. package/dist/docs/enums/WarningType.html +4 -5
  15. package/dist/docs/functions/isSupported.html +3 -0
  16. package/dist/docs/functions/setVonageMetadata.html +5 -0
  17. package/dist/docs/hierarchy.html +1 -0
  18. package/dist/docs/index.html +4 -13
  19. package/dist/docs/interfaces/MediaProcessorConnectorInterface.html +8 -3
  20. package/dist/docs/interfaces/MediaProcessorInterface.html +16 -13
  21. package/dist/docs/modules.html +1 -53
  22. package/dist/docs/types/DropInfo.html +6 -0
  23. package/dist/docs/types/ErrorData.html +8 -0
  24. package/dist/docs/types/EventDataMap.html +9 -0
  25. package/dist/docs/types/EventMetaData.html +4 -0
  26. package/dist/docs/types/VonageMetadata.html +8 -0
  27. package/dist/docs/types/WarnData.html +8 -0
  28. package/dist/media-processor.es.js +565 -386
  29. package/dist/media-processor.min.js +2 -1
  30. package/dist/media-processor.static.js +565 -386
  31. package/dist/media-processor.umd.js +2 -2
  32. package/dist/types/lib/main.d.ts +2 -0
  33. package/dist/types/lib/src/core/MediaProcessor.d.ts +12 -2
  34. package/dist/types/lib/src/core/MediaProcessorConnector.d.ts +1 -8
  35. package/dist/types/lib/src/core/MediaProcessorConnectorInterface.d.ts +0 -2
  36. package/dist/types/lib/src/core/MediaProcessorInterface.d.ts +8 -0
  37. package/dist/types/lib/src/core/pipeline.d.ts +5 -6
  38. package/dist/types/lib/src/utils/MediaStreamTrackGenerator.polyfill.d.ts +0 -0
  39. package/dist/types/lib/src/utils/MediaStreamTrackProcessor.polyfill.d.ts +0 -0
  40. package/dist/types/lib/src/utils/utils.d.ts +2 -0
  41. package/package.json +19 -21
  42. package/dist/docs/assets/icons.css +0 -1043
  43. package/dist/docs/assets/icons.png +0 -0
  44. package/dist/docs/assets/icons@2x.png +0 -0
  45. package/dist/docs/assets/widgets.png +0 -0
  46. package/dist/docs/assets/widgets@2x.png +0 -0
package/dist/docs/classes/MediaProcessor.html CHANGED
@@ -1,86 +1,106 @@
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 insertable streams pipeline.
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@vonage/media-processor</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">MediaProcessor</a></li></ul><h1>Class MediaProcessor</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Media processor class holding and running insertable streams pipeline.
3
2
  The class should be created on the proper thread.
4
3
  Options are:</p>
5
4
  <ul>
6
5
  <li>Application main thread when media processing wants to be performed in the main thread.</li>
7
6
  <li>Worker thread when media processing wants to be performed in a Web worker thread.</li>
8
7
  </ul>
9
- </div></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"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/MediaProcessorInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">MediaProcessorInterface</a></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">
10
- <p>Debugging options for the current instance.</p>
11
- </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">
12
- <p>Toggle debug mode for all instances.</p>
13
- </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>
14
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-2">Emittery</span><span class="hl-1">.</span><span class="hl-2">isDebugEnabled</span><span class="hl-1"> = </span><span class="hl-4">true</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter1</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">({</span><span class="hl-2">debug:</span><span class="hl-1"> {</span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;myEmitter1&#39;</span><span class="hl-1">}});</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter2</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">({</span><span class="hl-2">debug:</span><span class="hl-1"> {</span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;myEmitter2&#39;</span><span class="hl-1">}});</span><br/><br/><span class="hl-2">emitter1</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-3">&#39;test&#39;</span><span class="hl-1">, </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-7">// …</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter2</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-3">&#39;otherTest&#39;</span><span class="hl-1">, </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-7">// …</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter1</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;test&#39;</span><span class="hl-1">);</span><br/><span class="hl-7">//=&gt; [16:43:20.417][emittery:subscribe][myEmitter1] Event Name: test</span><br/><span class="hl-7">// data: undefined</span><br/><br/><span class="hl-2">emitter2</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;otherTest&#39;</span><span class="hl-1">);</span><br/><span class="hl-7">//=&gt; [16:43:20.417][emittery:subscribe][myEmitter2] Event Name: otherTest</span><br/><span class="hl-7">// data: undefined</span>
15
- </code></pre>
16
- </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">
17
- <p>Fires when an event listener was added.</p>
18
- </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>
19
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-2">Emittery</span><span class="hl-1">.</span><span class="hl-2">listenerAdded</span><span class="hl-1">, ({</span><span class="hl-2">listener</span><span class="hl-1">, </span><span class="hl-2">eventName</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">listener</span><span class="hl-1">);</span><br/><span class="hl-7">//=&gt; data =&gt; {}</span><br/><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">eventName</span><span class="hl-1">);</span><br/><span class="hl-7">//=&gt; &#39;🦄&#39;</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-7">// Handle data</span><br/><span class="hl-1">});</span>
20
- </code></pre>
21
- </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">
22
- <p>Fires when an event listener was removed.</p>
23
- </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>
24
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">off</span><span class="hl-1"> = </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-7">// Handle data</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-2">Emittery</span><span class="hl-1">.</span><span class="hl-2">listenerRemoved</span><span class="hl-1">, ({</span><span class="hl-2">listener</span><span class="hl-1">, </span><span class="hl-2">eventName</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">listener</span><span class="hl-1">);</span><br/><span class="hl-7">//=&gt; data =&gt; {}</span><br/><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">eventName</span><span class="hl-1">);</span><br/><span class="hl-7">//=&gt; &#39;🦄&#39;</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">off</span><span class="hl-1">();</span>
25
- </code></pre>
26
- </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><a href="../enums/PipelineInfoData.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PipelineInfoData</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">
27
- <p>Get an async iterator which buffers a tuple of an event name and data each time an event is emitted.</p>
28
- </div><div><p>Call <code>return()</code> on the iterator to remove the subscription.</p>
8
+ </div></section><section class="tsd-panel tsd-hierarchy" data-refl="45"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">default</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">MediaProcessor</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/MediaProcessorInterface.html" class="tsd-signature-type tsd-kind-interface">MediaProcessorInterface</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
9
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#debug" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>debug</span></a>
10
+ <a href="#isdebugenabled" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Debug<wbr/>Enabled</span></a>
11
+ <a href="#listeneradded" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>listener<wbr/>Added</span></a>
12
+ <a href="#listenerremoved" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>listener<wbr/>Removed</span></a>
13
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#anyevent" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>any<wbr/>Event</span></a>
14
+ <a href="#bindmethods" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>bind<wbr/>Methods</span></a>
15
+ <a href="#clearlisteners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Listeners</span></a>
16
+ <a href="#destroy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a>
17
+ <a href="#emit" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emit</span></a>
18
+ <a href="#emitserial" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emit<wbr/>Serial</span></a>
19
+ <a href="#events" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>events</span></a>
20
+ <a href="#listenercount" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listener<wbr/>Count</span></a>
21
+ <a href="#off" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off</span></a>
22
+ <a href="#offany" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off<wbr/>Any</span></a>
23
+ <a href="#on" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a>
24
+ <a href="#onany" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Any</span></a>
25
+ <a href="#once" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>once</span></a>
26
+ <a href="#settrackexpectedrate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Track<wbr/>Expected<wbr/>Rate</span></a>
27
+ <a href="#settransformers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Transformers</span></a>
28
+ <a href="#transform" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>transform</span></a>
29
+ <a href="#mixin" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mixin</span></a>
30
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructormediaprocessor"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">MediaProcessor</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MediaProcessor</a><a href="#constructormediaprocessor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">MediaProcessor</a></h4><aside class="tsd-sources"><p>Overrides Emittery&lt;EventDataMap&gt;.constructor</p></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="debug"><span>debug</span><a href="#debug" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">debug</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DebugOptions</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Debugging options for the current instance.</p>
31
+ </div><aside class="tsd-sources"><p>Inherited from Emittery.debug</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="isdebugenabled"><code class="tsd-tag">Static</code><span>is<wbr/>Debug<wbr/>Enabled</span><a href="#isdebugenabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">isDebugEnabled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Toggle debug mode for all instances.</p>
32
+ <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>
33
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-2">Emittery</span><span class="hl-1">.</span><span class="hl-2">isDebugEnabled</span><span class="hl-1"> = </span><span class="hl-4">true</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter1</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">({</span><span class="hl-2">debug:</span><span class="hl-1"> {</span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;myEmitter1&#39;</span><span class="hl-1">}});</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter2</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">({</span><span class="hl-2">debug:</span><span class="hl-1"> {</span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;myEmitter2&#39;</span><span class="hl-1">}});</span><br/><br/><span class="hl-2">emitter1</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-3">&#39;test&#39;</span><span class="hl-1">, </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// …</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter2</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-3">&#39;otherTest&#39;</span><span class="hl-1">, </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// …</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter1</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;test&#39;</span><span class="hl-1">);</span><br/><span class="hl-7">//=&gt; [16:43:20.417][emittery:subscribe][myEmitter1] Event Name: test</span><br/><span class="hl-7">// data: undefined</span><br/><br/><span class="hl-2">emitter2</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;otherTest&#39;</span><span class="hl-1">);</span><br/><span class="hl-7">//=&gt; [16:43:20.417][emittery:subscribe][myEmitter2] Event Name: otherTest</span><br/><span class="hl-7">// data: undefined</span>
34
+ </code><button>Copy</button></pre>
35
+
36
+ </div></div><aside class="tsd-sources"><p>Inherited from Emittery.isDebugEnabled</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="listeneradded"><code class="tsd-tag">Static</code> <code class="tsd-tag">Readonly</code><span>listener<wbr/>Added</span><a href="#listeneradded" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">listenerAdded</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">listenerAdded</span></div><div class="tsd-comment tsd-typography"><p>Fires when an event listener was added.</p>
37
+ <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>
38
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-2">Emittery</span><span class="hl-1">.</span><span class="hl-2">listenerAdded</span><span class="hl-1">, ({</span><span class="hl-2">listener</span><span class="hl-1">, </span><span class="hl-2">eventName</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-7">//=&gt; data =&gt; {}</span><br/><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">eventName</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-7">//=&gt; &#39;🦄&#39;</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// Handle data</span><br/><span class="hl-1">});</span>
39
+ </code><button>Copy</button></pre>
40
+
41
+ </div></div><aside class="tsd-sources"><p>Inherited from Emittery.listenerAdded</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="listenerremoved"><code class="tsd-tag">Static</code> <code class="tsd-tag">Readonly</code><span>listener<wbr/>Removed</span><a href="#listenerremoved" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">listenerRemoved</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">listenerRemoved</span></div><div class="tsd-comment tsd-typography"><p>Fires when an event listener was removed.</p>
42
+ <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>
43
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">off</span><span class="hl-1"> = </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// Handle data</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-2">Emittery</span><span class="hl-1">.</span><span class="hl-2">listenerRemoved</span><span class="hl-1">, ({</span><span class="hl-2">listener</span><span class="hl-1">, </span><span class="hl-2">eventName</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-7">//=&gt; data =&gt; {}</span><br/><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">eventName</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-7">//=&gt; &#39;🦄&#39;</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">off</span><span class="hl-1">();</span>
44
+ </code><button>Copy</button></pre>
45
+
46
+ </div></div><aside class="tsd-sources"><p>Inherited from Emittery.listenerRemoved</p></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="anyevent"><span>any<wbr/>Event</span><a href="#anyevent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="anyevent-1"><span class="tsd-kind-call-signature">anyEvent</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><br/>    <span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">,</span> <a href="../types/WarnData.html" class="tsd-signature-type tsd-kind-type-alias">WarnData</a> <span class="tsd-signature-symbol">|</span> <a href="../types/ErrorData.html" class="tsd-signature-type tsd-kind-type-alias">ErrorData</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/PipelineInfoData.html" class="tsd-signature-type tsd-kind-enum">PipelineInfoData</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#anyevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get an async iterator which buffers a tuple of an event name and data each time an event is emitted.</p>
47
+ <p>Call <code>return()</code> on the iterator to remove the subscription.</p>
29
48
  <p>In the same way as for <code>events</code>, you can subscribe by using the <code>for await</code> statement.</p>
30
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">iterator</span><span class="hl-1"> = </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">anyEvent</span><span class="hl-1">();</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈1&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🌟&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><br/><span class="hl-2">iterator</span><span class="hl-1">.</span><span class="hl-6">next</span><span class="hl-1">()</span><br/><span class="hl-1">.</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">value</span><span class="hl-1">, </span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-7">// done is false</span><br/><span class="hl-7">// value is [&#39;🦄&#39;, &#39;🌈1&#39;]</span><br/><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">iterator</span><span class="hl-1">.</span><span class="hl-6">next</span><span class="hl-1">();</span><br/><span class="hl-1">})</span><br/><span class="hl-1">.</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">value</span><span class="hl-1">, </span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-7">// done is false</span><br/><span class="hl-7">// value is [&#39;🌟&#39;, &#39;🌈2&#39;]</span><br/><span class="hl-7">// revoke subscription</span><br/><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">iterator</span><span class="hl-1">.</span><span class="hl-6">return</span><span class="hl-1">();</span><br/><span class="hl-1">})</span><br/><span class="hl-1">.</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-7">// done is true</span><br/><span class="hl-1">});</span>
31
- </code></pre>
32
- </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><a href="../enums/PipelineInfoData.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PipelineInfoData</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">
33
- <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>
34
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">object</span><span class="hl-1"> = {};</span><br/><br/><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">().</span><span class="hl-6">bindMethods</span><span class="hl-1">(</span><span class="hl-2">object</span><span class="hl-1">);</span><br/><br/><span class="hl-2">object</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;event&#39;</span><span class="hl-1">);</span>
35
- </code></pre>
36
- </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">
37
- <p>Clear all event listeners on the instance.</p>
38
- </div><div><p>If <code>eventName</code> is given, only the listeners for that event are cleared.</p>
39
- </div></div><h4 class="tsd-type-parameters-title">Type Parameters</h4><ul class="tsd-type-parameters"><li><h4>Name<span class="tsd-signature-symbol"> extends </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"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/MediaProcessorInterface.html">MediaProcessorInterface</a>.<a href="../interfaces/MediaProcessorInterface.html#destroy">destroy</a></p></aside><div class="tsd-comment tsd-typography"><div class="lead">
40
- <p>Stops running the tranformation logic performed by the media processor instance.</p>
41
- </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><div></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="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">
42
- <p>Trigger an event asynchronously, optionally with some data. Listeners are called in the order they were added, but executed concurrently.</p>
43
- </div></div><h4 class="tsd-type-parameters-title">Type Parameters</h4><ul class="tsd-type-parameters"><li><h4>Name<span class="tsd-signature-symbol"> extends </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>
44
- </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"> extends </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">
45
- <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>
46
- </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>
47
- </div></div><h4 class="tsd-type-parameters-title">Type Parameters</h4><ul class="tsd-type-parameters"><li><h4>Name<span class="tsd-signature-symbol"> extends </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>
48
- </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"> extends </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">
49
- <p>Get an async iterator which buffers data each time an event is emitted.</p>
50
- </div><div><p>Call <code>return()</code> on the iterator to remove the subscription.</p>
51
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">iterator</span><span class="hl-1"> = </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">events</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈1&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><br/><span class="hl-2">iterator</span><br/><span class="hl-1">.</span><span class="hl-6">next</span><span class="hl-1">()</span><br/><span class="hl-1">.</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">value</span><span class="hl-1">, </span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-7">// done === false</span><br/><span class="hl-7">// value === &#39;🌈1&#39;</span><br/><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">iterator</span><span class="hl-1">.</span><span class="hl-6">next</span><span class="hl-1">();</span><br/><span class="hl-1">})</span><br/><span class="hl-1">.</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">value</span><span class="hl-1">, </span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-7">// done === false</span><br/><span class="hl-7">// value === &#39;🌈2&#39;</span><br/><span class="hl-7">// Revoke subscription</span><br/><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">iterator</span><span class="hl-1">.</span><span class="hl-6">return</span><span class="hl-1">();</span><br/><span class="hl-1">})</span><br/><span class="hl-1">.</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-7">// done === true</span><br/><span class="hl-1">});</span>
52
- </code></pre>
49
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">,</span> <a href="../types/WarnData.html" class="tsd-signature-type tsd-kind-type-alias">WarnData</a> <span class="tsd-signature-symbol">|</span> <a href="../types/ErrorData.html" class="tsd-signature-type tsd-kind-type-alias">ErrorData</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/PipelineInfoData.html" class="tsd-signature-type tsd-kind-enum">PipelineInfoData</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-3">Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">iterator</span><span class="hl-1"> = </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">anyEvent</span><span class="hl-1">();</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈1&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🌟&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><br/><span class="hl-2">iterator</span><span class="hl-1">.</span><span class="hl-6">next</span><span class="hl-1">()</span><br/><span class="hl-1"> .</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">value</span><span class="hl-1">, </span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// done is false</span><br/><span class="hl-1"> </span><span class="hl-7">// value is [&#39;🦄&#39;, &#39;🌈1&#39;]</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">iterator</span><span class="hl-1">.</span><span class="hl-6">next</span><span class="hl-1">();</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> .</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">value</span><span class="hl-1">, </span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// done is false</span><br/><span class="hl-1"> </span><span class="hl-7">// value is [&#39;🌟&#39;, &#39;🌈2&#39;]</span><br/><span class="hl-1"> </span><span class="hl-7">// revoke subscription</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">iterator</span><span class="hl-1">.</span><span class="hl-6">return</span><span class="hl-1">();</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> .</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// done is true</span><br/><span class="hl-1"> });</span>
50
+ </code><button>Copy</button></pre>
51
+
52
+ </div></div><aside class="tsd-sources"><p>Inherited from Emittery.anyEvent</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="bindmethods"><span>bind<wbr/>Methods</span><a href="#bindmethods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="bindmethods-1"><span class="tsd-kind-call-signature">bindMethods</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">target</span><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><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">methodNames</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#bindmethods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><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>
53
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">target</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></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">methodNames</span>: <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-4">Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">object</span><span class="hl-1"> = {};</span><br/><br/><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">().</span><span class="hl-6">bindMethods</span><span class="hl-1">(</span><span class="hl-2">object</span><span class="hl-1">);</span><br/><br/><span class="hl-2">object</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;event&#39;</span><span class="hl-1">);</span>
54
+ </code><button>Copy</button></pre>
55
+
56
+ </div></div><aside class="tsd-sources"><p>Inherited from Emittery.bindMethods</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="clearlisteners"><span>clear<wbr/>Listeners</span><a href="#clearlisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="clearlisteners-1"><span class="tsd-kind-call-signature">clearListeners</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#clearlistenersname">Name</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#clearlistenersname">Name</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#clearlistenersname">Name</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#clearlisteners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clear all event listeners on the instance.</p>
57
+ <p>If <code>eventName</code> is given, only the listeners for that event are cleared.</p>
58
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="clearlistenersname"><span class="tsd-kind-type-parameter">Name</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">eventName</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#clearlistenersname">Name</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#clearlistenersname">Name</a><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from Emittery.clearListeners</p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="destroy"><span>destroy</span><a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="destroy-1"><span class="tsd-kind-call-signature">destroy</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><a href="#destroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Stops running the tranformation logic performed by the media processor instance.</p>
59
+ </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><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/MediaProcessorInterface.html">MediaProcessorInterface</a>.<a href="../interfaces/MediaProcessorInterface.html#destroy">destroy</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="emit"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="emit-1"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#emitname">Name</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#emitname">Name</a><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><a href="#emit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Trigger an event asynchronously, optionally with some data. Listeners are called in the order they were added, but executed concurrently.</p>
60
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="emitname"><span class="tsd-kind-type-parameter">Name</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#emitname">Name</a></span></li></ul></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><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'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>
61
+ <aside class="tsd-sources"><p>Inherited from Emittery.emit</p></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="emit-2"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#emitname-1">Name</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#emitname-1">Name</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">eventData</span><span class="tsd-signature-symbol">:</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#emitname-1">Name</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/><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><a href="#emit-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Trigger an event asynchronously, optionally with some data. Listeners are called in the order they were added, but executed concurrently.</p>
62
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="emitname-1"><span class="tsd-kind-type-parameter">Name</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#emitname-1">Name</a></span></li><li><span><span class="tsd-kind-parameter">eventData</span>: <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#emitname-1">Name</a><span class="tsd-signature-symbol">]</span></span></li></ul></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><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'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>
63
+ <aside class="tsd-sources"><p>Inherited from Emittery.emit</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="emitserial"><span>emit<wbr/>Serial</span><a href="#emitserial" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="emitserial-1"><span class="tsd-kind-call-signature">emitSerial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#emitserialname">Name</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#emitserialname">Name</a><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><a href="#emitserial-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><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>
64
+ <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>
65
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="emitserialname"><span class="tsd-kind-type-parameter">Name</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#emitserialname">Name</a></span></li></ul></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><p>A promise that resolves when all the event listeners are done.</p>
66
+ <aside class="tsd-sources"><p>Inherited from Emittery.emitSerial</p></aside></div></li><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="emitserial-2"><span class="tsd-kind-call-signature">emitSerial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#emitserialname-1">Name</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#emitserialname-1">Name</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">eventData</span><span class="tsd-signature-symbol">:</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#emitserialname-1">Name</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/><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><a href="#emitserial-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><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>
67
+ <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>
68
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="emitserialname-1"><span class="tsd-kind-type-parameter">Name</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#emitserialname-1">Name</a></span></li><li><span><span class="tsd-kind-parameter">eventData</span>: <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#emitserialname-1">Name</a><span class="tsd-signature-symbol">]</span></span></li></ul></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><p>A promise that resolves when all the event listeners are done.</p>
69
+ <aside class="tsd-sources"><p>Inherited from Emittery.emitSerial</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="events"><span>events</span><a href="#events" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="events-1"><span class="tsd-kind-call-signature">events</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#eventsname">Name</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#eventsname">Name</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#eventsname">Name</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><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="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#eventsname">Name</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><a href="#events-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get an async iterator which buffers data each time an event is emitted.</p>
70
+ <p>Call <code>return()</code> on the iterator to remove the subscription.</p>
71
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="eventsname"><span class="tsd-kind-type-parameter">Name</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#eventsname">Name</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#eventsname">Name</a><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#eventsname">Name</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-5">Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">iterator</span><span class="hl-1"> = </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">events</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈1&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><br/><span class="hl-2">iterator</span><br/><span class="hl-1"> .</span><span class="hl-6">next</span><span class="hl-1">()</span><br/><span class="hl-1"> .</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">value</span><span class="hl-1">, </span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// done === false</span><br/><span class="hl-1"> </span><span class="hl-7">// value === &#39;🌈1&#39;</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">iterator</span><span class="hl-1">.</span><span class="hl-6">next</span><span class="hl-1">();</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> .</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">value</span><span class="hl-1">, </span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// done === false</span><br/><span class="hl-1"> </span><span class="hl-7">// value === &#39;🌈2&#39;</span><br/><span class="hl-1"> </span><span class="hl-7">// Revoke subscription</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">iterator</span><span class="hl-1">.</span><span class="hl-6">return</span><span class="hl-1">();</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> .</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// done === true</span><br/><span class="hl-1"> });</span>
72
+ </code><button>Copy</button></pre>
73
+
53
74
  <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>
54
- </dd><dt>example</dt><dd><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">iterator</span><span class="hl-1"> = </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">events</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈1&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><br/><span class="hl-7">// In an async context.</span><br/><span class="hl-0">for</span><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> (</span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1"> </span><span class="hl-4">of</span><span class="hl-1"> </span><span class="hl-2">iterator</span><span class="hl-1">) {</span><br/><span class="hl-0">if</span><span class="hl-1"> (</span><span class="hl-2">data</span><span class="hl-1"> === </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-1">) {</span><br/><span class="hl-0">break</span><span class="hl-1">; </span><span class="hl-7">// Revoke the subscription when we see the value `🌈2`.</span><br/><span class="hl-1">}</span><br/><span class="hl-1">}</span>
55
- </code></pre>
75
+ </div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-6">Example<a href="#example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">iterator</span><span class="hl-1"> = </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">events</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈1&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><br/><span class="hl-7">// In an async context.</span><br/><span class="hl-0">for</span><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> (</span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">data</span><span class="hl-1"> </span><span class="hl-4">of</span><span class="hl-1"> </span><span class="hl-2">iterator</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (</span><span class="hl-2">data</span><span class="hl-1"> === </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">break</span><span class="hl-1">; </span><span class="hl-7">// Revoke the subscription when we see the value `🌈2`.</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
76
+ </code><button>Copy</button></pre>
77
+
56
78
  <p>It accepts multiple event names.</p>
57
- </dd><dt>example</dt><dd><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">iterator</span><span class="hl-1"> = </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">events</span><span class="hl-1">([</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-1">]);</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈1&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><br/><span class="hl-2">iterator</span><br/><span class="hl-1">.</span><span class="hl-6">next</span><span class="hl-1">()</span><br/><span class="hl-1">.</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">value</span><span class="hl-1">, </span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-7">// done === false</span><br/><span class="hl-7">// value === &#39;🌈1&#39;</span><br/><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">iterator</span><span class="hl-1">.</span><span class="hl-6">next</span><span class="hl-1">();</span><br/><span class="hl-1">})</span><br/><span class="hl-1">.</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">value</span><span class="hl-1">, </span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-7">// done === false</span><br/><span class="hl-7">// value === &#39;🌈2&#39;</span><br/><span class="hl-7">// Revoke subscription</span><br/><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">iterator</span><span class="hl-1">.</span><span class="hl-6">return</span><span class="hl-1">();</span><br/><span class="hl-1">})</span><br/><span class="hl-1">.</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-7">// done === true</span><br/><span class="hl-1">});</span>
58
- </code></pre>
59
- </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"> extends </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">
60
- <p>The number of listeners for the <code>eventName</code> or all events if not specified.</p>
61
- </div></div><h4 class="tsd-type-parameters-title">Type Parameters</h4><ul class="tsd-type-parameters"><li><h4>Name<span class="tsd-signature-symbol"> extends </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><span class="tsd-signature-symbol">(</span>eventData<span class="tsd-signature-symbol">: </span><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-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-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">
62
- <p>Remove one or more event subscriptions.</p>
63
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">listener</span><span class="hl-1"> = </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-1">(</span><span class="hl-4">async</span><span class="hl-1"> () </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">([</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-1">], </span><span class="hl-2">listener</span><span class="hl-1">);</span><br/><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;a&#39;</span><span class="hl-1">);</span><br/><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;b&#39;</span><span class="hl-1">);</span><br/><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;c&#39;</span><span class="hl-1">);</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">off</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-2">listener</span><span class="hl-1">);</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">off</span><span class="hl-1">([</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-1">], </span><span class="hl-2">listener</span><span class="hl-1">);</span><br/><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;a&#39;</span><span class="hl-1">); </span><span class="hl-7">// nothing happens</span><br/><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;b&#39;</span><span class="hl-1">); </span><span class="hl-7">// nothing happens</span><br/><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;c&#39;</span><span class="hl-1">); </span><span class="hl-7">// nothing happens</span><br/><span class="hl-1">})();</span>
64
- </code></pre>
65
- </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"> extends </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><span class="tsd-signature-symbol">(</span>eventData<span class="tsd-signature-symbol">: </span><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-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></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><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-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: <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-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><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><a href="../enums/PipelineInfoData.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PipelineInfoData</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-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">
66
- <p>Remove an <code>onAny</code> subscription.</p>
67
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>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><a href="../enums/PipelineInfoData.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PipelineInfoData</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></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><a href="../enums/PipelineInfoData.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PipelineInfoData</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><span class="tsd-signature-symbol"> | </span><a href="../enums/PipelineInfoData.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PipelineInfoData</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><span class="tsd-signature-symbol">(</span>eventData<span class="tsd-signature-symbol">: </span><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-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-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">
68
- <p>Subscribe to one or more events.</p>
69
- </div><div><p>Using the same listener multiple times for the same event will result in only one method call per emitted event.</p>
70
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">([</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">], </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈&#39;</span><span class="hl-1">); </span><span class="hl-7">// log =&gt; &#39;🌈&#39; x2</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🍖&#39;</span><span class="hl-1">); </span><span class="hl-7">// log =&gt; &#39;🍖&#39;</span>
71
- </code></pre>
72
- </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"> extends </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><span class="tsd-signature-symbol">(</span>eventData<span class="tsd-signature-symbol">: </span><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-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></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><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-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: <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-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>
73
- </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><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><a href="../enums/PipelineInfoData.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PipelineInfoData</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-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">
74
- <p>Subscribe to be notified about any event.</p>
75
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>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><a href="../enums/PipelineInfoData.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PipelineInfoData</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></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><a href="../enums/PipelineInfoData.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PipelineInfoData</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><span class="tsd-signature-symbol"> | </span><a href="../enums/PipelineInfoData.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PipelineInfoData</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>
76
- </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><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-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">
77
- <p>Subscribe to one or more events only once. It will be unsubscribed after the first
78
- event.</p>
79
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">once</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">).</span><span class="hl-6">then</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-7">//=&gt; &#39;🌈&#39;</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">once</span><span class="hl-1">([</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">]).</span><span class="hl-6">then</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈&#39;</span><span class="hl-1">); </span><span class="hl-7">// Logs `🌈` twice</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🍖&#39;</span><span class="hl-1">); </span><span class="hl-7">// Nothing happens</span>
80
- </code></pre>
81
- </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"> extends </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><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-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>
82
- </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">
83
- <p>Sets the expected rate of the track per second.
79
+ </div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-7">Example<a href="#example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">iterator</span><span class="hl-1"> = </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">events</span><span class="hl-1">([</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-1">]);</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈1&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈2&#39;</span><span class="hl-1">); </span><span class="hl-7">// Buffered</span><br/><br/><span class="hl-2">iterator</span><br/><span class="hl-1"> .</span><span class="hl-6">next</span><span class="hl-1">()</span><br/><span class="hl-1"> .</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">value</span><span class="hl-1">, </span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// done === false</span><br/><span class="hl-1"> </span><span class="hl-7">// value === &#39;🌈1&#39;</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">iterator</span><span class="hl-1">.</span><span class="hl-6">next</span><span class="hl-1">();</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> .</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">value</span><span class="hl-1">, </span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// done === false</span><br/><span class="hl-1"> </span><span class="hl-7">// value === &#39;🌈2&#39;</span><br/><span class="hl-1"> </span><span class="hl-7">// Revoke subscription</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-2">iterator</span><span class="hl-1">.</span><span class="hl-6">return</span><span class="hl-1">();</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> .</span><span class="hl-6">then</span><span class="hl-1">(({</span><span class="hl-2">done</span><span class="hl-1">}) </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// done === true</span><br/><span class="hl-1"> });</span>
80
+ </code><button>Copy</button></pre>
81
+
82
+ </div></div><aside class="tsd-sources"><p>Inherited from Emittery.events</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="listenercount"><span>listener<wbr/>Count</span><a href="#listenercount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="listenercount-1"><span class="tsd-kind-call-signature">listenerCount</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#listenercountname">Name</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#listenercountname">Name</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#listenercountname">Name</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#listenercount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The number of listeners for the <code>eventName</code> or all events if not specified.</p>
83
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="listenercountname"><span class="tsd-kind-type-parameter">Name</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">eventName</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#listenercountname">Name</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#listenercountname">Name</a><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><p>Inherited from Emittery.listenerCount</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="off"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="off-1"><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#offname">Name</a> <span class="tsd-signature-keyword">extends</span> (keyof EventDataMap) <span class="tsd-signature-symbol">|</span> (keyof OmnipresentEventData)<span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#offname">Name</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#offname">Name</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">eventData</span><span class="tsd-signature-symbol">:</span> (<a href="../types/EventDataMap.html" class="tsd-signature-type 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><a class="tsd-signature-type tsd-kind-type-parameter" href="#offname">Name</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/>    <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><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove one or more event subscriptions.</p>
84
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="offname"><span class="tsd-kind-type-parameter">Name</span> <span class="tsd-signature-keyword">extends</span> (keyof EventDataMap) <span class="tsd-signature-symbol">|</span> (keyof OmnipresentEventData)</span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#offname">Name</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#offname">Name</a><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventData</span><span class="tsd-signature-symbol">:</span> (<a href="../types/EventDataMap.html" class="tsd-signature-type 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><a class="tsd-signature-type tsd-kind-type-parameter" href="#offname">Name</a><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></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-8">Example<a href="#example-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-6">listener</span><span class="hl-1"> = </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">([</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-1">], </span><span class="hl-2">listener</span><span class="hl-1">);</span><br/><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;a&#39;</span><span class="hl-1">);</span><br/><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;b&#39;</span><span class="hl-1">);</span><br/><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;c&#39;</span><span class="hl-1">);</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">off</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-2">listener</span><span class="hl-1">);</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">off</span><span class="hl-1">([</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-1">], </span><span class="hl-2">listener</span><span class="hl-1">);</span><br/><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;a&#39;</span><span class="hl-1">); </span><span class="hl-7">// nothing happens</span><br/><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;b&#39;</span><span class="hl-1">); </span><span class="hl-7">// nothing happens</span><br/><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦊&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;c&#39;</span><span class="hl-1">); </span><span class="hl-7">// nothing happens</span>
85
+ </code><button>Copy</button></pre>
86
+
87
+ </div></div><aside class="tsd-sources"><p>Inherited from Emittery.off</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="offany"><span>off<wbr/>Any</span><a href="#offany" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="offany-1"><span class="tsd-kind-call-signature">offAny</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">eventData</span><span class="tsd-signature-symbol">:</span> <a href="../types/WarnData.html" class="tsd-signature-type tsd-kind-type-alias">WarnData</a> <span class="tsd-signature-symbol">|</span> <a href="../types/ErrorData.html" class="tsd-signature-type tsd-kind-type-alias">ErrorData</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/PipelineInfoData.html" class="tsd-signature-type tsd-kind-enum">PipelineInfoData</a><span class="tsd-signature-symbol">,</span><br/>    <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><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#offany-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove an <code>onAny</code> subscription.</p>
88
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">eventData</span><span class="tsd-signature-symbol">:</span> <a href="../types/WarnData.html" class="tsd-signature-type tsd-kind-type-alias">WarnData</a> <span class="tsd-signature-symbol">|</span> <a href="../types/ErrorData.html" class="tsd-signature-type tsd-kind-type-alias">ErrorData</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/PipelineInfoData.html" class="tsd-signature-type tsd-kind-enum">PipelineInfoData</a><span class="tsd-signature-symbol">,</span><br/><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></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from Emittery.offAny</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="on"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="on-1"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#onname">Name</a> <span class="tsd-signature-keyword">extends</span> (keyof EventDataMap) <span class="tsd-signature-symbol">|</span> (keyof OmnipresentEventData)<span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#onname">Name</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#onname">Name</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">eventData</span><span class="tsd-signature-symbol">:</span> (<a href="../types/EventDataMap.html" class="tsd-signature-type 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><a class="tsd-signature-type tsd-kind-type-parameter" href="#onname">Name</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/>    <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><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UnsubscribeFunction</span><a href="#on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Subscribe to one or more events.</p>
89
+ <p>Using the same listener multiple times for the same event will result in only one method call per emitted event.</p>
90
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="onname"><span class="tsd-kind-type-parameter">Name</span> <span class="tsd-signature-keyword">extends</span> (keyof EventDataMap) <span class="tsd-signature-symbol">|</span> (keyof OmnipresentEventData)</span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#onname">Name</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#onname">Name</a><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventData</span><span class="tsd-signature-symbol">:</span> (<a href="../types/EventDataMap.html" class="tsd-signature-type 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><a class="tsd-signature-type tsd-kind-type-parameter" href="#onname">Name</a><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></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span> <span class="tsd-signature-symbol">}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UnsubscribeFunction</span></h4><p>An unsubscribe method.</p>
91
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-9">Example<a href="#example-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">on</span><span class="hl-1">([</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">], </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈&#39;</span><span class="hl-1">); </span><span class="hl-7">// log =&gt; &#39;🌈&#39; x2</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🍖&#39;</span><span class="hl-1">); </span><span class="hl-7">// log =&gt; &#39;🍖&#39;</span>
92
+ </code><button>Copy</button></pre>
93
+
94
+ </div></div><aside class="tsd-sources"><p>Inherited from Emittery.on</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="onany"><span>on<wbr/>Any</span><a href="#onany" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="onany-1"><span class="tsd-kind-call-signature">onAny</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">eventData</span><span class="tsd-signature-symbol">:</span> <a href="../types/WarnData.html" class="tsd-signature-type tsd-kind-type-alias">WarnData</a> <span class="tsd-signature-symbol">|</span> <a href="../types/ErrorData.html" class="tsd-signature-type tsd-kind-type-alias">ErrorData</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/PipelineInfoData.html" class="tsd-signature-type tsd-kind-enum">PipelineInfoData</a><span class="tsd-signature-symbol">,</span><br/>    <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><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UnsubscribeFunction</span><a href="#onany-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Subscribe to be notified about any event.</p>
95
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">keyof</span> <a href="../types/EventDataMap.html" class="tsd-signature-type tsd-kind-type-alias">EventDataMap</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">eventData</span><span class="tsd-signature-symbol">:</span> <a href="../types/WarnData.html" class="tsd-signature-type tsd-kind-type-alias">WarnData</a> <span class="tsd-signature-symbol">|</span> <a href="../types/ErrorData.html" class="tsd-signature-type tsd-kind-type-alias">ErrorData</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/PipelineInfoData.html" class="tsd-signature-type tsd-kind-enum">PipelineInfoData</a><span class="tsd-signature-symbol">,</span><br/><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></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span> <span class="tsd-signature-symbol">}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UnsubscribeFunction</span></h4><p>A method to unsubscribe.</p>
96
+ <aside class="tsd-sources"><p>Inherited from Emittery.onAny</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="once"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="once-1"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#oncename">Name</a> <span class="tsd-signature-keyword">extends</span> (keyof EventDataMap) <span class="tsd-signature-symbol">|</span> (keyof OmnipresentEventData)<span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#oncename">Name</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#oncename">Name</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">predicate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">eventData</span><span class="tsd-signature-symbol">:</span> (<a href="../types/EventDataMap.html" class="tsd-signature-type 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><a class="tsd-signature-type tsd-kind-type-parameter" href="#oncename">Name</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EmitteryOncePromise</span><span class="tsd-signature-symbol">&lt;</span>(<a href="../types/EventDataMap.html" class="tsd-signature-type 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><a class="tsd-signature-type tsd-kind-type-parameter" href="#oncename">Name</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><a href="#once-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Subscribe to one or more events only once. It will be unsubscribed after the first event that matches the predicate (if provided).</p>
97
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="oncename"><span class="tsd-kind-type-parameter">Name</span> <span class="tsd-signature-keyword">extends</span> (keyof EventDataMap) <span class="tsd-signature-symbol">|</span> (keyof OmnipresentEventData)</span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventName</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#oncename">Name</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">readonly</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#oncename">Name</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The event name(s) to subscribe to.</p>
98
+ </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">predicate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventData</span><span class="tsd-signature-symbol">:</span> (<a href="../types/EventDataMap.html" class="tsd-signature-type 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><a class="tsd-signature-type tsd-kind-type-parameter" href="#oncename">Name</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Optional predicate function to filter event data. The event will only be emitted if the predicate returns true.</p>
99
+ </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EmitteryOncePromise</span><span class="tsd-signature-symbol">&lt;</span>(<a href="../types/EventDataMap.html" class="tsd-signature-type 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><a class="tsd-signature-type tsd-kind-type-parameter" href="#oncename">Name</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The promise of event data when <code>eventName</code> is emitted and predicate matches (if provided). This promise is extended with an <code>off</code> method.</p>
100
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-10">Example<a href="#example-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">emitter</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Emittery</span><span class="hl-1">();</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">once</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">).</span><span class="hl-6">then</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-7">//=&gt; &#39;🌈&#39;</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">once</span><span class="hl-1">([</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">]).</span><span class="hl-6">then</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-7">// With predicate</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">once</span><span class="hl-1">(</span><span class="hl-3">&#39;data&#39;</span><span class="hl-1">, </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">data</span><span class="hl-1">.</span><span class="hl-2">ok</span><span class="hl-1"> === </span><span class="hl-4">true</span><span class="hl-1">).</span><span class="hl-6">then</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-7">//=&gt; {ok: true, value: 42}</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🦄&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🌈&#39;</span><span class="hl-1">); </span><span class="hl-7">// Logs `🌈` twice</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;🐶&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;🍖&#39;</span><span class="hl-1">); </span><span class="hl-7">// Nothing happens</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;data&#39;</span><span class="hl-1">, {</span><span class="hl-2">ok:</span><span class="hl-1"> </span><span class="hl-4">false</span><span class="hl-1">}); </span><span class="hl-7">// Nothing happens</span><br/><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;data&#39;</span><span class="hl-1">, {</span><span class="hl-2">ok:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1">, </span><span class="hl-2">value:</span><span class="hl-1"> </span><span class="hl-8">42</span><span class="hl-1">}); </span><span class="hl-7">// Logs {ok: true, value: 42}</span>
101
+ </code><button>Copy</button></pre>
102
+
103
+ </div></div><aside class="tsd-sources"><p>Inherited from Emittery.once</p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="settrackexpectedrate"><span>set<wbr/>Track<wbr/>Expected<wbr/>Rate</span><a href="#settrackexpectedrate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="settrackexpectedrate-1"><span class="tsd-kind-call-signature">setTrackExpectedRate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">trackExpectedRate</span><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><a href="#settrackexpectedrate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the expected rate of the track per second.
84
104
  The media processor will use this number for calculating drops in the rate.
85
105
  This could happen when the transformation will take more time than expected.
86
106
  This will not cause an error, just warning to the client.
@@ -89,27 +109,21 @@ Video: 30 frames per second
89
109
  Audio: 50 audio data per second for OPUS
90
110
  In case of increased frame dropping rate a warning will be emitted according to info <a href="/docs/intro#errors-and-warnings-listener">here</a>.
91
111
  <em><strong>This is an optional method.</strong></em></p>
92
- </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">
93
- <p>number holds the predicted track rate.</p>
94
- </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">
95
- <p>Sets an array of transfromer instances that will be hold and ran by the media processor instance.
112
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">trackExpectedRate</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>number holds the predicted track rate.</p>
113
+ </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="settransformers"><span>set<wbr/>Transformers</span><a href="#settransformers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="settransformers-1"><span class="tsd-kind-call-signature">setTransformers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">transformers</span><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><a href="#settransformers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets an array of transfromer instances that will be hold and ran by the media processor instance.
96
114
  See example <a href="/docs/intro#main-code">here</a></p>
97
- </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">
98
- <p>An array of transformer instances.</p>
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><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="transform" class="tsd-anchor"></a><h3 class="tsd-anchor-link">transform<a href="#transform" 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">transform<span class="tsd-signature-symbol">(</span>readable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span>, writable<span class="tsd-signature-symbol">: </span><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><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>Implementation of <a href="../interfaces/MediaProcessorInterface.html">MediaProcessorInterface</a>.<a href="../interfaces/MediaProcessorInterface.html#transform">transform</a></p></aside><div class="tsd-comment tsd-typography"><div class="lead">
100
- <p>Starts running the tranformation logic performed by the media processor instance.
115
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">transformers</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><div class="tsd-comment tsd-typography"><p>An array of transformer instances.</p>
116
+ </div></li></ul></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></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="transform"><span>transform</span><a href="#transform" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="transform-1"><span class="tsd-kind-call-signature">transform</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">readable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">writable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WritableStream</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><a href="#transform-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Starts running the tranformation logic performed by the media processor instance.
101
117
  When running an instance of this class on a Web worker thread the call for this function should be made by the user. See example <a href="/docs/intro#webworker-code">here</a>.
102
118
  When running an instance of this class on the application main thread there is no need to call this method given it will be called by the <code>MediaProcessorConnector</code> instance.</p>
103
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>readable: <span class="tsd-signature-type">ReadableStream</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">
104
- <p>Readable stream associated to the media source being processed.</p>
105
- </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">
106
- <p>Writable stream associated to the resulting media once processed.</p>
107
- </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><div></div></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">(</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><span class="tsd-signature-symbol">)</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">
108
- <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>
109
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-1">@</span><span class="hl-2">Emittery</span><span class="hl-1">.</span><span class="hl-6">mixin</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">)</span><br/><span class="hl-4">class</span><span class="hl-1"> </span><span class="hl-8">MyClass</span><span class="hl-1"> {}</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">instance</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">MyClass</span><span class="hl-1">();</span><br/><br/><span class="hl-2">instance</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;event&#39;</span><span class="hl-1">);</span>
110
- </code></pre>
111
- </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">(</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><span class="tsd-signature-symbol">)</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">
112
- <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>
113
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-1">@</span><span class="hl-2">Emittery</span><span class="hl-1">.</span><span class="hl-6">mixin</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">)</span><br/><span class="hl-4">class</span><span class="hl-1"> </span><span class="hl-8">MyClass</span><span class="hl-1"> {}</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">instance</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">MyClass</span><span class="hl-1">();</span><br/><br/><span class="hl-2">instance</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;event&#39;</span><span class="hl-1">);</span>
114
- </code></pre>
115
- </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"> extends </span><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><span class="tsd-signature-symbol">)</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>
119
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">readable</span>: <span class="tsd-signature-type">ReadableStream</span></span><div class="tsd-comment tsd-typography"><p>Readable stream associated to the media source being processed.</p>
120
+ </div></li><li><span><span class="tsd-kind-parameter">writable</span>: <span class="tsd-signature-type">WritableStream</span></span><div class="tsd-comment tsd-typography"><p>Writable stream associated to the resulting media once processed.</p>
121
+ </div></li></ul></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><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/MediaProcessorInterface.html">MediaProcessorInterface</a>.<a href="../interfaces/MediaProcessorInterface.html#transform">transform</a></p></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="transform-2"><span class="tsd-kind-call-signature">transform</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">track</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MediaStreamTrack</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">MediaStreamTrack</span><span class="tsd-signature-symbol">&gt;</span><a href="#transform-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Starts running the tranformation logic performed by the media processor instance.
122
+ Special case of transform for browsers implementing the proposed standard, which only works inside webworkers. Only Webkit for now..</p>
123
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">track</span>: <span class="tsd-signature-type">MediaStreamTrack</span></span><div class="tsd-comment tsd-typography"><p>Track to be processed.</p>
124
+ </div></li></ul></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">MediaStreamTrack</span><span class="tsd-signature-symbol">&gt;</span></h4><p>New track to be used.</p>
125
+ <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/MediaProcessorInterface.html">MediaProcessorInterface</a>.<a href="../interfaces/MediaProcessorInterface.html#transform">transform</a></p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="mixin"><code class="tsd-tag">Static</code><span>mixin</span><a href="#mixin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="mixin-1"><span class="tsd-kind-call-signature">mixin</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">emitteryPropertyName</span><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><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">methodNames</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">new</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">arguments_</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">klass</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type tsd-kind-type-parameter">T</span><a href="#mixin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><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>
126
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">emitteryPropertyName</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">methodNames</span>: <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">new</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">arguments_</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">klass</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-11">Example<a href="#example-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">Emittery</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-1">@</span><span class="hl-2">Emittery</span><span class="hl-1">.</span><span class="hl-6">mixin</span><span class="hl-1">(</span><span class="hl-3">&#39;emittery&#39;</span><span class="hl-1">)</span><br/><span class="hl-4">class</span><span class="hl-1"> </span><span class="hl-9">MyClass</span><span class="hl-1"> {}</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">instance</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">MyClass</span><span class="hl-1">();</span><br/><br/><span class="hl-2">instance</span><span class="hl-1">.</span><span class="hl-6">emit</span><span class="hl-1">(</span><span class="hl-3">&#39;event&#39;</span><span class="hl-1">);</span>
127
+ </code><button>Copy</button></pre>
128
+
129
+ </div></div><aside class="tsd-sources"><p>Inherited from Emittery.mixin</p></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#debug" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>debug</span></a><a href="#isdebugenabled" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Debug<wbr/>Enabled</span></a><a href="#listeneradded" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>listener<wbr/>Added</span></a><a href="#listenerremoved" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>listener<wbr/>Removed</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#anyevent" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>any<wbr/>Event</span></a><a href="#bindmethods" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>bind<wbr/>Methods</span></a><a href="#clearlisteners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Listeners</span></a><a href="#destroy"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a><a href="#emit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emit</span></a><a href="#emitserial" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emit<wbr/>Serial</span></a><a href="#events" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>events</span></a><a href="#listenercount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listener<wbr/>Count</span></a><a href="#off" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off</span></a><a href="#offany" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off<wbr/>Any</span></a><a href="#on" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a><a href="#onany" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Any</span></a><a href="#once" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>once</span></a><a href="#settrackexpectedrate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Track<wbr/>Expected<wbr/>Rate</span></a><a href="#settransformers"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Transformers</span></a><a href="#transform"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>transform</span></a><a href="#mixin" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mixin</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@vonage/media-processor</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>