@vonage/ml-transformers 4.3.2 → 4.3.4

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 (66) hide show
  1. package/dist/ml-transformers.es.js +3521 -3521
  2. package/dist/ml-transformers.min.js +2 -2
  3. package/dist/ml-transformers.static.js +3521 -3521
  4. package/dist/ml-transformers.umd.js +48 -48
  5. package/dist/types/main.d.ts +3 -18
  6. package/dist/types/src/types.d.ts +67 -25
  7. package/package.json +7 -8
  8. package/dist/docs/.nojekyll +0 -1
  9. package/dist/docs/assets/highlight.css +0 -85
  10. package/dist/docs/assets/main.js +0 -54
  11. package/dist/docs/assets/search.js +0 -1
  12. package/dist/docs/assets/style.css +0 -1257
  13. package/dist/docs/classes/BackgroundTransformer.html +0 -165
  14. package/dist/docs/classes/MediapipeHelper.html +0 -124
  15. package/dist/docs/classes/VonageMediaProcessor.html +0 -608
  16. package/dist/docs/enums/BlurRadius.html +0 -70
  17. package/dist/docs/enums/ErrorFunction.html +0 -77
  18. package/dist/docs/enums/PipelineInfoData.html +0 -102
  19. package/dist/docs/enums/SelfieSegmentationType.html +0 -68
  20. package/dist/docs/enums/WarningType.html +0 -63
  21. package/dist/docs/functions/createVonageMediaProcessor.html +0 -111
  22. package/dist/docs/functions/getSupportedBrowserFeatures.html +0 -109
  23. package/dist/docs/functions/getVonageFaceDetection.html +0 -116
  24. package/dist/docs/functions/getVonageFaceMash.html +0 -119
  25. package/dist/docs/functions/getVonageHands.html +0 -100
  26. package/dist/docs/functions/getVonageHolistic.html +0 -125
  27. package/dist/docs/functions/getVonageObjectron.html +0 -111
  28. package/dist/docs/functions/getVonagePose.html +0 -113
  29. package/dist/docs/functions/getVonageSelfieSegmentation.html +0 -105
  30. package/dist/docs/functions/isSupported.html +0 -109
  31. package/dist/docs/index.html +0 -106
  32. package/dist/docs/interfaces/FaceDetectionOptions.html +0 -75
  33. package/dist/docs/interfaces/FaceDetectionResults.html +0 -70
  34. package/dist/docs/interfaces/FaceMeshOptions.html +0 -105
  35. package/dist/docs/interfaces/FaceMeshResults.html +0 -75
  36. package/dist/docs/interfaces/FeatureSupport.html +0 -74
  37. package/dist/docs/interfaces/HandsOptions.html +0 -85
  38. package/dist/docs/interfaces/HandsResults.html +0 -80
  39. package/dist/docs/interfaces/HolisticOptions.html +0 -105
  40. package/dist/docs/interfaces/HolisticResults.html +0 -95
  41. package/dist/docs/interfaces/ObjectronOptions.html +0 -105
  42. package/dist/docs/interfaces/ObjectronResults.html +0 -70
  43. package/dist/docs/interfaces/PoseOptions.html +0 -95
  44. package/dist/docs/interfaces/PoseResults.html +0 -80
  45. package/dist/docs/interfaces/SelfieSegmentationOptions.html +0 -70
  46. package/dist/docs/interfaces/SelfieSegmentationResults.html +0 -70
  47. package/dist/docs/interfaces/SupportedBrowserFeatures.html +0 -95
  48. package/dist/docs/modules.html +0 -160
  49. package/dist/docs/types/AssetBackgroundConfig.html +0 -103
  50. package/dist/docs/types/BackgroundBlurConfig.html +0 -107
  51. package/dist/docs/types/BackgroundOptions.html +0 -96
  52. package/dist/docs/types/DropInfo.html +0 -107
  53. package/dist/docs/types/ErrorData.html +0 -111
  54. package/dist/docs/types/EventDataMap.html +0 -112
  55. package/dist/docs/types/EventMetaData.html +0 -103
  56. package/dist/docs/types/MediaPipeModelConfig.html +0 -124
  57. package/dist/docs/types/MediaPipeModelType.html +0 -96
  58. package/dist/docs/types/MediaPipeResults.html +0 -96
  59. package/dist/docs/types/MediaPipeResultsListener.html +0 -122
  60. package/dist/docs/types/MediaProcessorBaseConfig.html +0 -120
  61. package/dist/docs/types/MediaProcessorConfig.html +0 -96
  62. package/dist/docs/types/MediapipeConfig.html +0 -106
  63. package/dist/docs/types/SilhouetteBlurConfig.html +0 -107
  64. package/dist/docs/types/VideoBackgroundConfig.html +0 -103
  65. package/dist/docs/types/VirtualBackgroundConfig.html +0 -103
  66. package/dist/docs/types/WarnData.html +0 -111
@@ -1,608 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VonageMediaProcessor | @vonage/ml-transformers</title><meta name="description" content="Documentation for @vonage/ml-transformers"/><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.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
- <div class="tsd-toolbar-contents container">
3
- <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
- <div class="field">
6
- <div id="tsd-toolbar-links"></div></div>
7
- <ul class="results">
8
- <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@vonage/ml-transformers</a></div>
10
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
- <div class="container container-main">
12
- <div class="col-8 col-content">
13
- <div class="tsd-page-title">
14
- <ul class="tsd-breadcrumb">
15
- <li><a href="../modules.html">@vonage/ml-transformers</a></li>
16
- <li><a href="VonageMediaProcessor.html">VonageMediaProcessor</a></li></ul>
17
- <h1>Class VonageMediaProcessor</h1></div>
18
- <section class="tsd-panel tsd-comment">
19
- <div class="tsd-comment tsd-typography"><p>Class wrapping features provided by ml-transformers.</p>
20
- </div></section>
21
- <section class="tsd-panel tsd-hierarchy">
22
- <h4>Hierarchy</h4>
23
- <ul class="tsd-hierarchy">
24
- <li><span class="tsd-signature-type">Emittery</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol">&gt;</span>
25
- <ul class="tsd-hierarchy">
26
- <li><span class="target">VonageMediaProcessor</span></li></ul></li></ul></section>
27
- <section class="tsd-panel-group tsd-index-group">
28
- <section class="tsd-panel tsd-index-panel">
29
- <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
30
- <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
31
- <div class="tsd-accordion-details">
32
- <section class="tsd-index-section">
33
- <h3 class="tsd-index-heading">Properties</h3>
34
- <div class="tsd-index-list"><a href="VonageMediaProcessor.html#debug" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>debug</span></a>
35
- <a href="VonageMediaProcessor.html#isDebugEnabled" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>is<wbr/>Debug<wbr/>Enabled</span></a>
36
- <a href="VonageMediaProcessor.html#listenerAdded" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>listener<wbr/>Added</span></a>
37
- <a href="VonageMediaProcessor.html#listenerRemoved" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>listener<wbr/>Removed</span></a>
38
- </div></section>
39
- <section class="tsd-index-section">
40
- <h3 class="tsd-index-heading">Methods</h3>
41
- <div class="tsd-index-list"><a href="VonageMediaProcessor.html#anyEvent" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>any<wbr/>Event</span></a>
42
- <a href="VonageMediaProcessor.html#bindMethods" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>bind<wbr/>Methods</span></a>
43
- <a href="VonageMediaProcessor.html#clearListeners" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>clear<wbr/>Listeners</span></a>
44
- <a href="VonageMediaProcessor.html#emit" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>emit</span></a>
45
- <a href="VonageMediaProcessor.html#emitSerial" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>emit<wbr/>Serial</span></a>
46
- <a href="VonageMediaProcessor.html#events" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>events</span></a>
47
- <a href="VonageMediaProcessor.html#getConnector" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Connector</span></a>
48
- <a href="VonageMediaProcessor.html#listenerCount" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>listener<wbr/>Count</span></a>
49
- <a href="VonageMediaProcessor.html#off" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>off</span></a>
50
- <a href="VonageMediaProcessor.html#offAny" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>off<wbr/>Any</span></a>
51
- <a href="VonageMediaProcessor.html#on" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>on</span></a>
52
- <a href="VonageMediaProcessor.html#onAny" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>on<wbr/>Any</span></a>
53
- <a href="VonageMediaProcessor.html#once" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>once</span></a>
54
- <a href="VonageMediaProcessor.html#profile" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>profile</span></a>
55
- <a href="VonageMediaProcessor.html#setBackgroundOptions" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Background<wbr/>Options</span></a>
56
- <a href="VonageMediaProcessor.html#setTrackExpectedRate" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Track<wbr/>Expected<wbr/>Rate</span></a>
57
- <a href="VonageMediaProcessor.html#create" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create</span></a>
58
- <a href="VonageMediaProcessor.html#mixin" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>mixin</span></a>
59
- <a href="VonageMediaProcessor.html#profile-2" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>profile</span></a>
60
- </div></section></div></details></section></section>
61
- <section class="tsd-panel-group tsd-member-group">
62
- <h2>Properties</h2>
63
- <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>
64
- <h3 class="tsd-anchor-link"><span>debug</span><a href="#debug" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
65
- <div class="tsd-signature">debug<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" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol">&gt;</span></div>
66
- <div class="tsd-comment tsd-typography"><p>Debugging options for the current instance.</p>
67
- </div><aside class="tsd-sources">
68
- <p>Inherited from Emittery.debug</p></aside></section>
69
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="isDebugEnabled" class="tsd-anchor"></a>
70
- <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Debug<wbr/>Enabled</span><a href="#isDebugEnabled" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
71
- <div class="tsd-signature">is<wbr/>Debug<wbr/>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
72
- <div class="tsd-comment tsd-typography"><p>Toggle debug mode for all instances.</p>
73
- <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>
74
-
75
- <h3>Example</h3><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-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>
76
- </code></pre>
77
- </div><aside class="tsd-sources">
78
- <p>Inherited from Emittery.isDebugEnabled</p></aside></section>
79
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="listenerAdded" class="tsd-anchor"></a>
80
- <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>listener<wbr/>Added</span><a href="#listenerAdded" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
81
- <div class="tsd-signature">listener<wbr/>Added<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">listenerAdded</span></div>
82
- <div class="tsd-comment tsd-typography"><p>Fires when an event listener was added.</p>
83
- <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>
84
-
85
- <h3>Example</h3><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-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>
86
- </code></pre>
87
- </div><aside class="tsd-sources">
88
- <p>Inherited from Emittery.listenerAdded</p></aside></section>
89
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="listenerRemoved" class="tsd-anchor"></a>
90
- <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>listener<wbr/>Removed</span><a href="#listenerRemoved" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
91
- <div class="tsd-signature">listener<wbr/>Removed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">listenerRemoved</span></div>
92
- <div class="tsd-comment tsd-typography"><p>Fires when an event listener was removed.</p>
93
- <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>
94
-
95
- <h3>Example</h3><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-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>
96
- </code></pre>
97
- </div><aside class="tsd-sources">
98
- <p>Inherited from Emittery.listenerRemoved</p></aside></section></section>
99
- <section class="tsd-panel-group tsd-member-group">
100
- <h2>Methods</h2>
101
- <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>
102
- <h3 class="tsd-anchor-link"><span>any<wbr/>Event</span><a href="#anyEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
103
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
104
- <li class="tsd-signature tsd-anchor-link" id="anyEvent.anyEvent-1">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="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol">, </span><a href="../types/WarnData.html" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../types/ErrorData.html" 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><a href="#anyEvent.anyEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
105
- <li class="tsd-description">
106
- <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>
107
- <p>Call <code>return()</code> on the iterator to remove the subscription.</p>
108
- <p>In the same way as for <code>events</code>, you can subscribe by using the <code>for await</code> statement.</p>
109
-
110
- <h3>Example</h3><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-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>
111
- </code></pre>
112
- </div>
113
- <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="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a><span class="tsd-signature-symbol">, </span><a href="../types/WarnData.html" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../types/ErrorData.html" 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><aside class="tsd-sources">
114
- <p>Inherited from Emittery.anyEvent</p></aside></li></ul></section>
115
- <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>
116
- <h3 class="tsd-anchor-link"><span>bind<wbr/>Methods</span><a href="#bindMethods" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
117
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
118
- <li class="tsd-signature tsd-anchor-link" id="bindMethods.bindMethods-1">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><a href="#bindMethods.bindMethods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
119
- <li class="tsd-description">
120
- <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>
121
-
122
- <h3>Example</h3><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>
123
- </code></pre>
124
- </div>
125
- <div class="tsd-parameters">
126
- <h4 class="tsd-parameters-title">Parameters</h4>
127
- <ul class="tsd-parameter-list">
128
- <li>
129
- <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>
130
- <li>
131
- <h5><code class="tsd-tag ts-flagOptional">Optional</code> methodNames: <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
132
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
133
- <p>Inherited from Emittery.bindMethods</p></aside></li></ul></section>
134
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="clearListeners" class="tsd-anchor"></a>
135
- <h3 class="tsd-anchor-link"><span>clear<wbr/>Listeners</span><a href="#clearListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
136
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
137
- <li class="tsd-signature tsd-anchor-link" id="clearListeners.clearListeners-1">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><a href="#clearListeners.clearListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
138
- <li class="tsd-description">
139
- <div class="tsd-comment tsd-typography"><p>Clear all event listeners on the instance.</p>
140
- <p>If <code>eventName</code> is given, only the listeners for that event are cleared.</p>
141
- </div>
142
- <section class="tsd-panel tsd-type-parameters">
143
- <h4>Type Parameters</h4>
144
- <ul class="tsd-type-parameters">
145
- <li>
146
- <h4>Name<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">keyof </span><a href="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a></h4></li></ul></section>
147
- <div class="tsd-parameters">
148
- <h4 class="tsd-parameters-title">Parameters</h4>
149
- <ul class="tsd-parameter-list">
150
- <li>
151
- <h5><code class="tsd-tag ts-flagOptional">Optional</code> 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></div>
152
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
153
- <p>Inherited from Emittery.clearListeners</p></aside></li></ul></section>
154
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="emit" class="tsd-anchor"></a>
155
- <h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
156
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
157
- <li class="tsd-signature tsd-anchor-link" id="emit.emit-1">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><a href="#emit.emit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
158
- <li class="tsd-description">
159
- <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>
160
-
161
- <h3>Returns</h3><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>
162
- </div>
163
- <section class="tsd-panel tsd-type-parameters">
164
- <h4>Type Parameters</h4>
165
- <ul class="tsd-type-parameters">
166
- <li>
167
- <h4>Name<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">never</span></h4></li></ul></section>
168
- <div class="tsd-parameters">
169
- <h4 class="tsd-parameters-title">Parameters</h4>
170
- <ul class="tsd-parameter-list">
171
- <li>
172
- <h5>eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span></h5></li></ul></div>
173
- <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">
174
- <p>Inherited from Emittery.emit</p></aside></li>
175
- <li class="tsd-signature tsd-anchor-link" id="emit.emit-2">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="../types/EventDataMap.html" 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><a href="#emit.emit-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
176
- <li class="tsd-description">
177
- <section class="tsd-panel tsd-type-parameters">
178
- <h4>Type Parameters</h4>
179
- <ul class="tsd-type-parameters">
180
- <li>
181
- <h4>Name<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">keyof </span><a href="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a></h4></li></ul></section>
182
- <div class="tsd-parameters">
183
- <h4 class="tsd-parameters-title">Parameters</h4>
184
- <ul class="tsd-parameter-list">
185
- <li>
186
- <h5>eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span></h5></li>
187
- <li>
188
- <h5>eventData: <a href="../types/EventDataMap.html" 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></div>
189
- <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">
190
- <p>Inherited from Emittery.emit</p></aside></li></ul></section>
191
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="emitSerial" class="tsd-anchor"></a>
192
- <h3 class="tsd-anchor-link"><span>emit<wbr/>Serial</span><a href="#emitSerial" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
193
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
194
- <li class="tsd-signature tsd-anchor-link" id="emitSerial.emitSerial-1">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><a href="#emitSerial.emitSerial-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
195
- <li class="tsd-description">
196
- <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>
197
- <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>
198
-
199
- <h3>Returns</h3><p>A promise that resolves when all the event listeners are done.</p>
200
- </div>
201
- <section class="tsd-panel tsd-type-parameters">
202
- <h4>Type Parameters</h4>
203
- <ul class="tsd-type-parameters">
204
- <li>
205
- <h4>Name<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">never</span></h4></li></ul></section>
206
- <div class="tsd-parameters">
207
- <h4 class="tsd-parameters-title">Parameters</h4>
208
- <ul class="tsd-parameter-list">
209
- <li>
210
- <h5>eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span></h5></li></ul></div>
211
- <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">
212
- <p>Inherited from Emittery.emitSerial</p></aside></li>
213
- <li class="tsd-signature tsd-anchor-link" id="emitSerial.emitSerial-2">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="../types/EventDataMap.html" 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><a href="#emitSerial.emitSerial-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
214
- <li class="tsd-description">
215
- <section class="tsd-panel tsd-type-parameters">
216
- <h4>Type Parameters</h4>
217
- <ul class="tsd-type-parameters">
218
- <li>
219
- <h4>Name<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">keyof </span><a href="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a></h4></li></ul></section>
220
- <div class="tsd-parameters">
221
- <h4 class="tsd-parameters-title">Parameters</h4>
222
- <ul class="tsd-parameter-list">
223
- <li>
224
- <h5>eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Name</span></h5></li>
225
- <li>
226
- <h5>eventData: <a href="../types/EventDataMap.html" 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></div>
227
- <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">
228
- <p>Inherited from Emittery.emitSerial</p></aside></li></ul></section>
229
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="events" class="tsd-anchor"></a>
230
- <h3 class="tsd-anchor-link"><span>events</span><a href="#events" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
231
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
232
- <li class="tsd-signature tsd-anchor-link" id="events.events-1">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="../types/EventDataMap.html" 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><a href="#events.events-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
233
- <li class="tsd-description">
234
- <div class="tsd-comment tsd-typography"><p>Get an async iterator which buffers data each time an event is emitted.</p>
235
- <p>Call <code>return()</code> on the iterator to remove the subscription.</p>
236
-
237
- <h3>Example</h3><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-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>
238
- </code></pre>
239
- <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>
240
-
241
- <h3>Example</h3><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-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>
242
- </code></pre>
243
- <p>It accepts multiple event names.</p>
244
-
245
- <h3>Example</h3><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-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>
246
- </code></pre>
247
- </div>
248
- <section class="tsd-panel tsd-type-parameters">
249
- <h4>Type Parameters</h4>
250
- <ul class="tsd-type-parameters">
251
- <li>
252
- <h4>Name<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">keyof </span><a href="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a></h4></li></ul></section>
253
- <div class="tsd-parameters">
254
- <h4 class="tsd-parameters-title">Parameters</h4>
255
- <ul class="tsd-parameter-list">
256
- <li>
257
- <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></div>
258
- <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" 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><aside class="tsd-sources">
259
- <p>Inherited from Emittery.events</p></aside></li></ul></section>
260
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getConnector" class="tsd-anchor"></a>
261
- <h3 class="tsd-anchor-link"><span>get<wbr/>Connector</span><a href="#getConnector" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
262
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
263
- <li class="tsd-signature tsd-anchor-link" id="getConnector.getConnector-1">get<wbr/>Connector<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MediaProcessorConnector</span><a href="#getConnector.getConnector-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
264
- <li class="tsd-description">
265
- <div class="tsd-comment tsd-typography"><p>Getter for MediaProcessorConnectorInterface connector attribute.</p>
266
-
267
- <h3>Returns</h3><ul>
268
- <li><code>MediaProcessorConnectorInterface</code> feed this return value to any vonage SDK that supports this API</li>
269
- </ul>
270
- </div>
271
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MediaProcessorConnector</span></h4></li></ul></section>
272
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="listenerCount" class="tsd-anchor"></a>
273
- <h3 class="tsd-anchor-link"><span>listener<wbr/>Count</span><a href="#listenerCount" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
274
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
275
- <li class="tsd-signature tsd-anchor-link" id="listenerCount.listenerCount-1">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><a href="#listenerCount.listenerCount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
276
- <li class="tsd-description">
277
- <div class="tsd-comment tsd-typography"><p>The number of listeners for the <code>eventName</code> or all events if not specified.</p>
278
- </div>
279
- <section class="tsd-panel tsd-type-parameters">
280
- <h4>Type Parameters</h4>
281
- <ul class="tsd-type-parameters">
282
- <li>
283
- <h4>Name<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">keyof </span><a href="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a></h4></li></ul></section>
284
- <div class="tsd-parameters">
285
- <h4 class="tsd-parameters-title">Parameters</h4>
286
- <ul class="tsd-parameter-list">
287
- <li>
288
- <h5><code class="tsd-tag ts-flagOptional">Optional</code> 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></div>
289
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
290
- <p>Inherited from Emittery.listenerCount</p></aside></li></ul></section>
291
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="off" class="tsd-anchor"></a>
292
- <h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
293
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
294
- <li class="tsd-signature tsd-anchor-link" id="off.off-1">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="../types/EventDataMap.html" 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><a href="#off.off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
295
- <li class="tsd-description">
296
- <div class="tsd-comment tsd-typography"><p>Remove one or more event subscriptions.</p>
297
-
298
- <h3>Example</h3><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-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-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-1"> </span><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-1"> </span><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-1"> </span><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-1"> </span><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-1"> </span><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-1"> </span><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-1"> </span><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-1"> </span><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>
299
- </code></pre>
300
- </div>
301
- <section class="tsd-panel tsd-type-parameters">
302
- <h4>Type Parameters</h4>
303
- <ul class="tsd-type-parameters">
304
- <li>
305
- <h4>Name<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">keyof </span><a href="../types/EventDataMap.html" 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></section>
306
- <div class="tsd-parameters">
307
- <h4 class="tsd-parameters-title">Parameters</h4>
308
- <ul class="tsd-parameter-list">
309
- <li>
310
- <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>
311
- <li>
312
- <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="../types/EventDataMap.html" 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>
313
- <ul class="tsd-parameters">
314
- <li class="tsd-parameter-signature">
315
- <ul class="tsd-signatures tsd-kind-type-literal tsd-is-external">
316
- <li class="tsd-signature"><span class="tsd-signature-symbol">(</span>eventData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><a href="../types/EventDataMap.html" 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>
317
- <li class="tsd-description">
318
- <div class="tsd-parameters">
319
- <h4 class="tsd-parameters-title">Parameters</h4>
320
- <ul class="tsd-parameter-list">
321
- <li>
322
- <h5>eventData: <span class="tsd-signature-symbol">(</span><a href="../types/EventDataMap.html" 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></div>
323
- <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></div>
324
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
325
- <p>Inherited from Emittery.off</p></aside></li></ul></section>
326
- <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>
327
- <h3 class="tsd-anchor-link"><span>off<wbr/>Any</span><a href="#offAny" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
328
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
329
- <li class="tsd-signature tsd-anchor-link" id="offAny.offAny-1">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="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a>, eventData<span class="tsd-signature-symbol">: </span><a href="../types/WarnData.html" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../types/ErrorData.html" 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><a href="#offAny.offAny-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
330
- <li class="tsd-description">
331
- <div class="tsd-comment tsd-typography"><p>Remove an <code>onAny</code> subscription.</p>
332
- </div>
333
- <div class="tsd-parameters">
334
- <h4 class="tsd-parameters-title">Parameters</h4>
335
- <ul class="tsd-parameter-list">
336
- <li>
337
- <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="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a>, eventData<span class="tsd-signature-symbol">: </span><a href="../types/WarnData.html" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../types/ErrorData.html" 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>
338
- <ul class="tsd-parameters">
339
- <li class="tsd-parameter-signature">
340
- <ul class="tsd-signatures tsd-kind-type-literal tsd-is-external">
341
- <li class="tsd-signature"><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a>, eventData<span class="tsd-signature-symbol">: </span><a href="../types/WarnData.html" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../types/ErrorData.html" 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>
342
- <li class="tsd-description">
343
- <div class="tsd-parameters">
344
- <h4 class="tsd-parameters-title">Parameters</h4>
345
- <ul class="tsd-parameter-list">
346
- <li>
347
- <h5>eventName: <span class="tsd-signature-symbol">keyof </span><a href="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a></h5></li>
348
- <li>
349
- <h5>eventData: <a href="../types/WarnData.html" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../types/ErrorData.html" 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></div>
350
- <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></div>
351
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
352
- <p>Inherited from Emittery.offAny</p></aside></li></ul></section>
353
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="on" class="tsd-anchor"></a>
354
- <h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
355
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
356
- <li class="tsd-signature tsd-anchor-link" id="on.on-1">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="../types/EventDataMap.html" 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><a href="#on.on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
357
- <li class="tsd-description">
358
- <div class="tsd-comment tsd-typography"><p>Subscribe to one or more events.</p>
359
- <p>Using the same listener multiple times for the same event will result in only one method call per emitted event.</p>
360
-
361
- <h3>Returns</h3><p>An unsubscribe method.</p>
362
-
363
- <h3>Example</h3><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-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>
364
- </code></pre>
365
- </div>
366
- <section class="tsd-panel tsd-type-parameters">
367
- <h4>Type Parameters</h4>
368
- <ul class="tsd-type-parameters">
369
- <li>
370
- <h4>Name<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">keyof </span><a href="../types/EventDataMap.html" 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></section>
371
- <div class="tsd-parameters">
372
- <h4 class="tsd-parameters-title">Parameters</h4>
373
- <ul class="tsd-parameter-list">
374
- <li>
375
- <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>
376
- <li>
377
- <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="../types/EventDataMap.html" 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>
378
- <ul class="tsd-parameters">
379
- <li class="tsd-parameter-signature">
380
- <ul class="tsd-signatures tsd-kind-type-literal tsd-is-external">
381
- <li class="tsd-signature"><span class="tsd-signature-symbol">(</span>eventData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><a href="../types/EventDataMap.html" 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>
382
- <li class="tsd-description">
383
- <div class="tsd-parameters">
384
- <h4 class="tsd-parameters-title">Parameters</h4>
385
- <ul class="tsd-parameter-list">
386
- <li>
387
- <h5>eventData: <span class="tsd-signature-symbol">(</span><a href="../types/EventDataMap.html" 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></div>
388
- <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></div>
389
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UnsubscribeFn</span></h4><aside class="tsd-sources">
390
- <p>Inherited from Emittery.on</p></aside></li></ul></section>
391
- <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>
392
- <h3 class="tsd-anchor-link"><span>on<wbr/>Any</span><a href="#onAny" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
393
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
394
- <li class="tsd-signature tsd-anchor-link" id="onAny.onAny-1">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="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a>, eventData<span class="tsd-signature-symbol">: </span><a href="../types/WarnData.html" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../types/ErrorData.html" 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><a href="#onAny.onAny-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
395
- <li class="tsd-description">
396
- <div class="tsd-comment tsd-typography"><p>Subscribe to be notified about any event.</p>
397
-
398
- <h3>Returns</h3><p>A method to unsubscribe.</p>
399
- </div>
400
- <div class="tsd-parameters">
401
- <h4 class="tsd-parameters-title">Parameters</h4>
402
- <ul class="tsd-parameter-list">
403
- <li>
404
- <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="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a>, eventData<span class="tsd-signature-symbol">: </span><a href="../types/WarnData.html" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../types/ErrorData.html" 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>
405
- <ul class="tsd-parameters">
406
- <li class="tsd-parameter-signature">
407
- <ul class="tsd-signatures tsd-kind-type-literal tsd-is-external">
408
- <li class="tsd-signature"><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a>, eventData<span class="tsd-signature-symbol">: </span><a href="../types/WarnData.html" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../types/ErrorData.html" 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>
409
- <li class="tsd-description">
410
- <div class="tsd-parameters">
411
- <h4 class="tsd-parameters-title">Parameters</h4>
412
- <ul class="tsd-parameter-list">
413
- <li>
414
- <h5>eventName: <span class="tsd-signature-symbol">keyof </span><a href="../types/EventDataMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">EventDataMap</a></h5></li>
415
- <li>
416
- <h5>eventData: <a href="../types/WarnData.html" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> | </span><a href="../types/ErrorData.html" 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></div>
417
- <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></div>
418
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UnsubscribeFn</span></h4><aside class="tsd-sources">
419
- <p>Inherited from Emittery.onAny</p></aside></li></ul></section>
420
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="once" class="tsd-anchor"></a>
421
- <h3 class="tsd-anchor-link"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
422
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
423
- <li class="tsd-signature tsd-anchor-link" id="once.once-1">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="../types/EventDataMap.html" 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><a href="#once.once-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
424
- <li class="tsd-description">
425
- <div class="tsd-comment tsd-typography"><p>Subscribe to one or more events only once. It will be unsubscribed after the first
426
- event.</p>
427
-
428
- <h3>Returns</h3><p>The event data when <code>eventName</code> is emitted.</p>
429
-
430
- <h3>Example</h3><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-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-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>
431
- </code></pre>
432
- </div>
433
- <section class="tsd-panel tsd-type-parameters">
434
- <h4>Type Parameters</h4>
435
- <ul class="tsd-type-parameters">
436
- <li>
437
- <h4>Name<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">keyof </span><a href="../types/EventDataMap.html" 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></section>
438
- <div class="tsd-parameters">
439
- <h4 class="tsd-parameters-title">Parameters</h4>
440
- <ul class="tsd-parameter-list">
441
- <li>
442
- <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></div>
443
- <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="../types/EventDataMap.html" 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><aside class="tsd-sources">
444
- <p>Inherited from Emittery.once</p></aside></li></ul></section>
445
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="profile" class="tsd-anchor"></a>
446
- <h3 class="tsd-anchor-link"><span>profile</span><a href="#profile" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
447
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
448
- <li class="tsd-signature tsd-anchor-link" id="profile.profile-1">profile<span class="tsd-signature-symbol">(</span>duration<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ResolvedWebglQuery</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#profile.profile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
449
- <li class="tsd-description">
450
- <div class="tsd-parameters">
451
- <h4 class="tsd-parameters-title">Parameters</h4>
452
- <ul class="tsd-parameter-list">
453
- <li>
454
- <h5>duration: <span class="tsd-signature-type">number</span></h5></li></ul></div>
455
- <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">ResolvedWebglQuery</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section>
456
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setBackgroundOptions" class="tsd-anchor"></a>
457
- <h3 class="tsd-anchor-link"><span>set<wbr/>Background<wbr/>Options</span><a href="#setBackgroundOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
458
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
459
- <li class="tsd-signature tsd-anchor-link" id="setBackgroundOptions.setBackgroundOptions-1">set<wbr/>Background<wbr/>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../types/BackgroundOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">BackgroundOptions</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="#setBackgroundOptions.setBackgroundOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
460
- <li class="tsd-description">
461
- <div class="tsd-comment tsd-typography"><p>change the background option during run time using this function.
462
- while using this function the media-processor will not be destroyed.
463
- while using this function the library promise a full resource cleanup.</p>
464
- </div>
465
- <div class="tsd-parameters">
466
- <h4 class="tsd-parameters-title">Parameters</h4>
467
- <ul class="tsd-parameter-list">
468
- <li>
469
- <h5>options: <a href="../types/BackgroundOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">BackgroundOptions</a></h5></li></ul></div>
470
- <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>
471
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setTrackExpectedRate" class="tsd-anchor"></a>
472
- <h3 class="tsd-anchor-link"><span>set<wbr/>Track<wbr/>Expected<wbr/>Rate</span><a href="#setTrackExpectedRate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
473
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
474
- <li class="tsd-signature tsd-anchor-link" id="setTrackExpectedRate.setTrackExpectedRate-1">set<wbr/>Track<wbr/>Expected<wbr/>Rate<span class="tsd-signature-symbol">(</span>rate<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.setTrackExpectedRate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
475
- <li class="tsd-description">
476
- <div class="tsd-comment tsd-typography"><p>Sets the expected rate of the track per second.
477
- The media processor will use this number for calculating drops in the rate.
478
- This could happen when the transformation will take more time than expected.
479
- This will not cause an error, just warning to the client.
480
- Mostly:
481
- Video: 30 frames per second
482
- Audio: 50 audio data per second for OPUS</p>
483
- </div>
484
- <div class="tsd-parameters">
485
- <h4 class="tsd-parameters-title">Parameters</h4>
486
- <ul class="tsd-parameter-list">
487
- <li>
488
- <h5>rate: <span class="tsd-signature-type">number</span></h5>
489
- <div class="tsd-comment tsd-typography"><p>number holds the predicted track rate. -1 for disable this monitor.</p>
490
- </div></li></ul></div>
491
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section>
492
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
493
- <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>create</span><a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
494
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
495
- <li class="tsd-signature tsd-anchor-link" id="create.create-1">create<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="../types/MediaProcessorConfig.html" class="tsd-signature-type" data-tsd-kind="Type alias">MediaProcessorConfig</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><a href="VonageMediaProcessor.html" class="tsd-signature-type" data-tsd-kind="Class">VonageMediaProcessor</a><span class="tsd-signature-symbol">&gt;</span><a href="#create.create-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
496
- <li class="tsd-description">
497
- <div class="tsd-comment tsd-typography"><p>Asynchronous constructor of VonageMediaProcessor</p>
498
-
499
- <h3>Returns</h3><p>Promise resolved with an initialized MediaProcessorConfig</p>
500
- </div>
501
- <div class="tsd-parameters">
502
- <h4 class="tsd-parameters-title">Parameters</h4>
503
- <ul class="tsd-parameter-list">
504
- <li>
505
- <h5>config: <a href="../types/MediaProcessorConfig.html" class="tsd-signature-type" data-tsd-kind="Type alias">MediaProcessorConfig</a></h5>
506
- <div class="tsd-comment tsd-typography"><p>Initial MediaProcessorConfig to use</p>
507
- </div></li></ul></div>
508
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="VonageMediaProcessor.html" class="tsd-signature-type" data-tsd-kind="Class">VonageMediaProcessor</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section>
509
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="mixin" class="tsd-anchor"></a>
510
- <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>mixin</span><a href="#mixin" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
511
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
512
- <li class="tsd-signature tsd-anchor-link" id="mixin.mixin-1">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><a href="#mixin.mixin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
513
- <li class="tsd-description">
514
- <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>
515
-
516
- <h3>Example</h3><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>
517
- </code></pre>
518
- </div>
519
- <div class="tsd-parameters">
520
- <h4 class="tsd-parameters-title">Parameters</h4>
521
- <ul class="tsd-parameter-list">
522
- <li>
523
- <h5>emitteryPropertyName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li>
524
- <li>
525
- <h5><code class="tsd-tag ts-flagOptional">Optional</code> methodNames: <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
526
- <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>
527
- <ul class="tsd-parameters">
528
- <li class="tsd-parameter-signature">
529
- <ul class="tsd-signatures tsd-kind-type-literal tsd-is-external">
530
- <li class="tsd-signature" id="mixin.mixin-1.__type.__type-1"><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>
531
- <li class="tsd-description">
532
- <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>
533
-
534
- <h3>Example</h3><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>
535
- </code></pre>
536
- </div>
537
- <section class="tsd-panel tsd-type-parameters">
538
- <h4>Type Parameters</h4>
539
- <ul class="tsd-type-parameters">
540
- <li>
541
- <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></section>
542
- <div class="tsd-parameters">
543
- <h4 class="tsd-parameters-title">Parameters</h4>
544
- <ul class="tsd-parameter-list">
545
- <li>
546
- <h5>klass: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul></div>
547
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4></li></ul></li></ul><aside class="tsd-sources">
548
- <p>Inherited from Emittery.mixin</p></aside></li></ul></section>
549
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="profile-2" class="tsd-anchor"></a>
550
- <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>profile</span><a href="#profile-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
551
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
552
- <li class="tsd-signature tsd-anchor-link" id="profile-2.profile-3">profile<span class="tsd-signature-symbol">(</span>duration<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">WebglProfilerReporter</span><span class="tsd-signature-symbol">&gt;</span><a href="#profile-2.profile-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
553
- <li class="tsd-description">
554
- <div class="tsd-parameters">
555
- <h4 class="tsd-parameters-title">Parameters</h4>
556
- <ul class="tsd-parameter-list">
557
- <li>
558
- <h5>duration: <span class="tsd-signature-type">number</span></h5></li></ul></div>
559
- <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">WebglProfilerReporter</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div>
560
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
561
- <div class="tsd-navigation settings">
562
- <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
563
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
564
- <div class="tsd-accordion-details">
565
- <div class="tsd-filter-visibility">
566
- <h4 class="uppercase">Member Visibility</h4><form>
567
- <ul id="tsd-filter-options">
568
- <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>
569
- <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></form></div>
570
- <div class="tsd-theme-toggle">
571
- <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
572
- <nav class="tsd-navigation primary">
573
- <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
574
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
575
- <div class="tsd-accordion-details">
576
- <ul>
577
- <li><a href="../modules.html">@vonage/ml-<wbr/>transformers</a>
578
- <ul></ul></li></ul></div></details></nav>
579
- <nav class="tsd-navigation secondary menu-sticky">
580
- <ul>
581
- <li class="current tsd-kind-class"><a href="VonageMediaProcessor.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Vonage<wbr/>Media<wbr/>Processor</span></a>
582
- <ul>
583
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#debug" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>debug</a></li>
584
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#isDebugEnabled" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>is<wbr/>Debug<wbr/>Enabled</a></li>
585
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#listenerAdded" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>listener<wbr/>Added</a></li>
586
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#listenerRemoved" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>listener<wbr/>Removed</a></li>
587
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#anyEvent" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>any<wbr/>Event</a></li>
588
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#bindMethods" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>bind<wbr/>Methods</a></li>
589
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#clearListeners" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>clear<wbr/>Listeners</a></li>
590
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#emit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>emit</a></li>
591
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#emitSerial" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>emit<wbr/>Serial</a></li>
592
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#events" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>events</a></li>
593
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="VonageMediaProcessor.html#getConnector" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Connector</a></li>
594
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#listenerCount" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>listener<wbr/>Count</a></li>
595
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#off" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>off</a></li>
596
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#offAny" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>off<wbr/>Any</a></li>
597
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#on" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>on</a></li>
598
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#onAny" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>on<wbr/>Any</a></li>
599
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#once" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>once</a></li>
600
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="VonageMediaProcessor.html#profile" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>profile</a></li>
601
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="VonageMediaProcessor.html#setBackgroundOptions" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Background<wbr/>Options</a></li>
602
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="VonageMediaProcessor.html#setTrackExpectedRate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Track<wbr/>Expected<wbr/>Rate</a></li>
603
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="VonageMediaProcessor.html#create" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>create</a></li>
604
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="VonageMediaProcessor.html#mixin" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>mixin</a></li>
605
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="VonageMediaProcessor.html#profile-2" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>profile</a></li></ul></li></ul></nav></div></div>
606
- <div class="container tsd-generator">
607
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
608
- <div class="overlay"></div><script src="../assets/main.js"></script></body></html>