iframe-coordinator-cli 6.5.0 → 6.5.1

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 (43) hide show
  1. package/dist/assets/{index-DkVijnku.js → index-DejhDHus.js} +3 -3
  2. package/dist/ifc-docs/assets/hierarchy.js +1 -1
  3. package/dist/ifc-docs/assets/highlight.css +130 -91
  4. package/dist/ifc-docs/assets/icons.js +20 -17
  5. package/dist/ifc-docs/assets/icons.svg +1 -1
  6. package/dist/ifc-docs/assets/main.js +2535 -5
  7. package/dist/ifc-docs/assets/navigation.js +2 -1
  8. package/dist/ifc-docs/assets/search.js +2 -1
  9. package/dist/ifc-docs/assets/style.css +1571 -1581
  10. package/dist/ifc-docs/classes/client.Client.html +2388 -98
  11. package/dist/ifc-docs/classes/client.WorkerClient.html +2161 -92
  12. package/dist/ifc-docs/classes/host.FrameRouterElement.html +850 -24
  13. package/dist/ifc-docs/classes/host.WorkerPool.html +879 -29
  14. package/dist/ifc-docs/documents/client-setup.html +579 -75
  15. package/dist/ifc-docs/functions/host.registerCustomElements.html +218 -3
  16. package/dist/ifc-docs/hierarchy.html +168 -1
  17. package/dist/ifc-docs/index.html +432 -31
  18. package/dist/ifc-docs/interfaces/client.ClientConfigOptions.html +331 -4
  19. package/dist/ifc-docs/interfaces/client.EventEmitter.html +752 -14
  20. package/dist/ifc-docs/interfaces/host.ClientConfig.html +399 -7
  21. package/dist/ifc-docs/interfaces/host.ClientRegistration.html +580 -24
  22. package/dist/ifc-docs/interfaces/host.RoutingMap.html +211 -4
  23. package/dist/ifc-docs/interfaces/host.WorkerAppData.html +388 -6
  24. package/dist/ifc-docs/interfaces/host.WorkerConfig.html +398 -7
  25. package/dist/ifc-docs/interfaces/host.WorkerItem.html +401 -6
  26. package/dist/ifc-docs/interfaces/host.WorkerRegistry.html +210 -2
  27. package/dist/ifc-docs/interfaces/messages.Breadcrumb.html +373 -6
  28. package/dist/ifc-docs/interfaces/messages.EnvData.html +510 -11
  29. package/dist/ifc-docs/interfaces/messages.KeyData.html +540 -12
  30. package/dist/ifc-docs/interfaces/messages.ModalRequest.html +381 -6
  31. package/dist/ifc-docs/interfaces/messages.NavRequest.html +390 -9
  32. package/dist/ifc-docs/interfaces/messages.Notification.html +435 -9
  33. package/dist/ifc-docs/interfaces/messages.PageMetadata.html +438 -8
  34. package/dist/ifc-docs/interfaces/messages.PromptOnLeave.html +390 -9
  35. package/dist/ifc-docs/interfaces/messages.Publication.html +443 -11
  36. package/dist/ifc-docs/modules/client.html +742 -2
  37. package/dist/ifc-docs/modules/host.html +647 -1
  38. package/dist/ifc-docs/modules/messages.html +462 -1
  39. package/dist/ifc-docs/modules.html +359 -1
  40. package/dist/ifc-docs/types/client.EnvDataHandler.html +239 -1
  41. package/dist/ifc-docs/types/client.EventHandler.html +247 -2
  42. package/dist/index.html +1 -1
  43. package/package.json +3 -3
@@ -1,29 +1,879 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkerPool | iframe-coordinator - v6.5.0</title><meta name="description" content="Documentation for iframe-coordinator"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">iframe-coordinator - v6.5.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/host.html">host</a></li><li><a href="" aria-current="page">WorkerPool</a></li></ul><h1>Class WorkerPool</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Class for managing a collection of worker processes that should run for the
2
- lifetime of the host application. Workers can be provided with basic
3
- application metadata, allowing them to generate URLs for and request
4
- navigation to a corresponding iframed client app that may or may not be
5
- currently loaded.</p>
6
- <p>The WorkerPool is an <a href="https://developer.mozilla.org/docs/Web/API/EventTarget">EventTarget</a> and emits events in the same way as the
7
- <a href="host.FrameRouterElement.html" class="tsd-kind-class">FrameRouterElement</a>, although with fewer
8
- possible events.</p>
9
- </div></section><section class="tsd-panel tsd-hierarchy" data-refl="104"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="https://developer.mozilla.org/docs/Web/API/EventTarget" class="tsd-signature-type external" target="_blank">EventTarget</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">WorkerPool</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/WorkerPool.ts#L59">WorkerPool.ts:59</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
10
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#isrunning" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Running</span></a>
11
- <a href="#workerconfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>worker<wbr/>Config</span></a>
12
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#publish" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>publish</span></a>
13
- <a href="#start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a>
14
- <a href="#stop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop</span></a>
15
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorworkerpool"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">WorkerPool</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">WorkerPool</a><a href="#constructorworkerpool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new worker pool</p>
16
- </div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">WorkerPool</a></h4><aside class="tsd-sources"><p>Overrides EventTarget.constructor</p><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/WorkerPool.ts#L94">WorkerPool.ts:94</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="isrunning"><span>is<wbr/>Running</span><a href="#isrunning" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="isrunningisrunning"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">isRunning</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>True if the worker is running.</p>
17
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/WorkerPool.ts#L125">WorkerPool.ts:125</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="workerconfig"><span>worker<wbr/>Config</span><a href="#workerconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="workerconfigworkerconfig"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">workerConfig</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/host.WorkerConfig.html" class="tsd-signature-type tsd-kind-interface">WorkerConfig</a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the configured workers for the pool.</p>
18
- </div><h4 class="tsd-returns-title">Returns <a href="../interfaces/host.WorkerConfig.html" class="tsd-signature-type tsd-kind-interface">WorkerConfig</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/WorkerPool.ts#L118">WorkerPool.ts:118</a></li></ul></aside></div></li><li><div class="tsd-signature" id="workerconfigworkerconfig-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">workerConfig</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">clientConfig</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/host.WorkerConfig.html" class="tsd-signature-type tsd-kind-interface">WorkerConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the configured workers for the pool.</p>
19
- <p>Changing this after the pool has been started will throw an Error. If you
20
- have a need to dynamically change the set of running workers, please reach
21
- out with your use case.</p>
22
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">clientConfig</span>: <a href="../interfaces/host.WorkerConfig.html" class="tsd-signature-type tsd-kind-interface">WorkerConfig</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/WorkerPool.ts#L107">WorkerPool.ts:107</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="publish"><span>publish</span><a href="#publish" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="publish-1"><span class="tsd-kind-call-signature">publish</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">clientId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">publication</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/messages.Publication.html" class="tsd-signature-type tsd-kind-interface">Publication</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#publish-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Publish a message to a worker.</p>
23
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">clientId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the worker the message should be published to</p>
24
- </div></li><li><span><span class="tsd-kind-parameter">publication</span>: <a href="../interfaces/messages.Publication.html" class="tsd-signature-type tsd-kind-interface">Publication</a></span><div class="tsd-comment tsd-typography"><p>The information published to the woker.
25
- The topic may not be of interest, and could be ignored.</p>
26
- </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/WorkerPool.ts#L176">WorkerPool.ts:176</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="start"><span>start</span><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="start-1"><span class="tsd-kind-call-signature">start</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#start-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Start the worker pool, and all associated workers.</p>
27
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/WorkerPool.ts#L132">WorkerPool.ts:132</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="stop"><span>stop</span><a href="#stop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="stop-1"><span class="tsd-kind-call-signature">stop</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#stop-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Stops the worker pool, immediately terminating all registered workers. Does
28
- nothing if the pool was never started.</p>
29
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/purecloudlabs/iframe-coordinator/blob/24a29952c135ede083858799b8f5e2a6b7ff78ef/packages/iframe-coordinator/src/WorkerPool.ts#L156">WorkerPool.ts:156</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#isrunning"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Running</span></a><a href="#workerconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>worker<wbr/>Config</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#publish"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>publish</span></a><a href="#start"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a><a href="#stop"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">iframe-coordinator - v6.5.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1
+ <!doctype html>
2
+ <html class="default" lang="en" data-base="../">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <meta http-equiv="x-ua-compatible" content="IE=edge" />
6
+ <title>WorkerPool | iframe-coordinator - v6.5.1</title>
7
+ <meta name="description" content="Documentation for iframe-coordinator" />
8
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
9
+ <link rel="stylesheet" href="../assets/style.css" />
10
+ <link rel="stylesheet" href="../assets/highlight.css" />
11
+ <script defer src="../assets/main.js"></script>
12
+ <script async src="../assets/icons.js" id="tsd-icons-script"></script>
13
+ <script async src="../assets/search.js" id="tsd-search-script"></script>
14
+ <script async src="../assets/navigation.js" id="tsd-nav-script"></script>
15
+ </head>
16
+ <body>
17
+ <script>
18
+ document.documentElement.dataset.theme =
19
+ localStorage.getItem("tsd-theme") || "os";
20
+ document.body.style.display = "none";
21
+ setTimeout(
22
+ () =>
23
+ window.app
24
+ ? app.showPage()
25
+ : document.body.style.removeProperty("display"),
26
+ 500,
27
+ );
28
+ </script>
29
+ <header class="tsd-page-toolbar">
30
+ <div class="tsd-toolbar-contents container">
31
+ <a href="../index.html" class="title">iframe-coordinator - v6.5.1</a>
32
+ <div id="tsd-toolbar-links"></div>
33
+ <button id="tsd-search-trigger" class="tsd-widget" aria-label="Search">
34
+ <svg
35
+ width="16"
36
+ height="16"
37
+ viewBox="0 0 16 16"
38
+ fill="none"
39
+ aria-hidden="true"
40
+ >
41
+ <use href="../assets/icons.svg#icon-search"></use>
42
+ </svg>
43
+ </button>
44
+ <dialog id="tsd-search" aria-label="Search">
45
+ <input
46
+ role="combobox"
47
+ id="tsd-search-input"
48
+ aria-controls="tsd-search-results"
49
+ aria-autocomplete="list"
50
+ aria-expanded="true"
51
+ autocapitalize="off"
52
+ autocomplete="off"
53
+ placeholder="Search the docs"
54
+ maxlength="100"
55
+ />
56
+ <ul role="listbox" id="tsd-search-results"></ul>
57
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
58
+ <div>Preparing search index...</div>
59
+ </div>
60
+ </dialog>
61
+ <a
62
+ href="#"
63
+ class="tsd-widget menu"
64
+ id="tsd-toolbar-menu-trigger"
65
+ data-toggle="menu"
66
+ aria-label="Menu"
67
+ ><svg
68
+ width="16"
69
+ height="16"
70
+ viewBox="0 0 16 16"
71
+ fill="none"
72
+ aria-hidden="true"
73
+ >
74
+ <use href="../assets/icons.svg#icon-menu"></use></svg
75
+ ></a>
76
+ </div>
77
+ </header>
78
+ <div class="container container-main">
79
+ <div class="col-content">
80
+ <div class="tsd-page-title">
81
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
82
+ <li><a href="../modules/host.html">host</a></li>
83
+ <li><a href="" aria-current="page">WorkerPool</a></li>
84
+ </ul>
85
+ <h1>Class WorkerPool</h1>
86
+ </div>
87
+ <section class="tsd-panel tsd-comment">
88
+ <div class="tsd-comment tsd-typography">
89
+ <p>
90
+ Class for managing a collection of worker processes that should
91
+ run for the lifetime of the host application. Workers can be
92
+ provided with basic application metadata, allowing them to
93
+ generate URLs for and request navigation to a corresponding
94
+ iframed client app that may or may not be currently loaded.
95
+ </p>
96
+ <p>
97
+ The WorkerPool is an
98
+ <a href="https://developer.mozilla.org/docs/Web/API/EventTarget"
99
+ >EventTarget</a
100
+ >
101
+ and emits events in the same way as the
102
+ <a href="host.FrameRouterElement.html" class="tsd-kind-class"
103
+ >FrameRouterElement</a
104
+ >, although with fewer possible events.
105
+ </p>
106
+ </div>
107
+ </section>
108
+ <section class="tsd-panel tsd-hierarchy" data-refl="104">
109
+ <h4>Hierarchy</h4>
110
+ <ul class="tsd-hierarchy">
111
+ <li class="tsd-hierarchy-item">
112
+ <a
113
+ href="https://developer.mozilla.org/docs/Web/API/EventTarget"
114
+ class="tsd-signature-type external"
115
+ target="_blank"
116
+ >EventTarget</a
117
+ >
118
+ <ul class="tsd-hierarchy">
119
+ <li class="tsd-hierarchy-item">
120
+ <span class="tsd-hierarchy-target">WorkerPool</span>
121
+ </li>
122
+ </ul>
123
+ </li>
124
+ </ul>
125
+ </section>
126
+ <aside class="tsd-sources">
127
+ <ul>
128
+ <li>
129
+ Defined in
130
+ <a
131
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/WorkerPool.ts#L59"
132
+ >WorkerPool.ts:59</a
133
+ >
134
+ </li>
135
+ </ul>
136
+ </aside>
137
+ <section class="tsd-panel-group tsd-index-group">
138
+ <section class="tsd-panel tsd-index-panel">
139
+ <details class="tsd-index-content tsd-accordion" open>
140
+ <summary class="tsd-accordion-summary tsd-index-summary">
141
+ <svg
142
+ width="20"
143
+ height="20"
144
+ viewBox="0 0 24 24"
145
+ fill="none"
146
+ aria-hidden="true"
147
+ >
148
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
149
+ </svg>
150
+ <h5 class="tsd-index-heading uppercase">Index</h5>
151
+ </summary>
152
+ <div class="tsd-accordion-details">
153
+ <section class="tsd-index-section">
154
+ <h3 class="tsd-index-heading">Constructors</h3>
155
+ <div class="tsd-index-list">
156
+ <a href="#constructor" class="tsd-index-link"
157
+ ><svg
158
+ class="tsd-kind-icon"
159
+ viewBox="0 0 24 24"
160
+ aria-label="Constructor"
161
+ >
162
+ <use href="../assets/icons.svg#icon-512"></use></svg
163
+ ><span>constructor</span></a
164
+ >
165
+ </div>
166
+ </section>
167
+ <section class="tsd-index-section">
168
+ <h3 class="tsd-index-heading">Accessors</h3>
169
+ <div class="tsd-index-list">
170
+ <a href="#isrunning" class="tsd-index-link"
171
+ ><svg
172
+ class="tsd-kind-icon"
173
+ viewBox="0 0 24 24"
174
+ aria-label="Accessor"
175
+ >
176
+ <use href="../assets/icons.svg#icon-262144"></use></svg
177
+ ><span>is<wbr />Running</span></a
178
+ >
179
+ <a href="#workerconfig" class="tsd-index-link"
180
+ ><svg
181
+ class="tsd-kind-icon"
182
+ viewBox="0 0 24 24"
183
+ aria-label="Accessor"
184
+ >
185
+ <use href="../assets/icons.svg#icon-262144"></use></svg
186
+ ><span>worker<wbr />Config</span></a
187
+ >
188
+ </div>
189
+ </section>
190
+ <section class="tsd-index-section">
191
+ <h3 class="tsd-index-heading">Methods</h3>
192
+ <div class="tsd-index-list">
193
+ <a href="#publish" class="tsd-index-link"
194
+ ><svg
195
+ class="tsd-kind-icon"
196
+ viewBox="0 0 24 24"
197
+ aria-label="Method"
198
+ >
199
+ <use href="../assets/icons.svg#icon-2048"></use></svg
200
+ ><span>publish</span></a
201
+ >
202
+ <a href="#start" class="tsd-index-link"
203
+ ><svg
204
+ class="tsd-kind-icon"
205
+ viewBox="0 0 24 24"
206
+ aria-label="Method"
207
+ >
208
+ <use href="../assets/icons.svg#icon-2048"></use></svg
209
+ ><span>start</span></a
210
+ >
211
+ <a href="#stop" class="tsd-index-link"
212
+ ><svg
213
+ class="tsd-kind-icon"
214
+ viewBox="0 0 24 24"
215
+ aria-label="Method"
216
+ >
217
+ <use href="../assets/icons.svg#icon-2048"></use></svg
218
+ ><span>stop</span></a
219
+ >
220
+ </div>
221
+ </section>
222
+ </div>
223
+ </details>
224
+ </section>
225
+ </section>
226
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
227
+ <summary
228
+ class="tsd-accordion-summary"
229
+ data-key="section-Constructors"
230
+ >
231
+ <svg
232
+ width="20"
233
+ height="20"
234
+ viewBox="0 0 24 24"
235
+ fill="none"
236
+ aria-hidden="true"
237
+ >
238
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
239
+ </svg>
240
+ <h2>Constructors</h2>
241
+ </summary>
242
+ <section>
243
+ <section class="tsd-panel tsd-member">
244
+ <h3 class="tsd-anchor-link" id="constructor">
245
+ <span>constructor</span
246
+ ><a
247
+ href="#constructor"
248
+ aria-label="Permalink"
249
+ class="tsd-anchor-icon"
250
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
251
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
252
+ ></a>
253
+ </h3>
254
+ <ul class="tsd-signatures">
255
+ <li class="">
256
+ <div
257
+ class="tsd-signature tsd-anchor-link"
258
+ id="constructorworkerpool"
259
+ >
260
+ <span class="tsd-signature-keyword">new</span>
261
+ <span class="tsd-kind-constructor-signature"
262
+ >WorkerPool</span
263
+ ><span class="tsd-signature-symbol">()</span
264
+ ><span class="tsd-signature-symbol">:</span>
265
+ <a href="" class="tsd-signature-type tsd-kind-class"
266
+ >WorkerPool</a
267
+ ><a
268
+ href="#constructorworkerpool"
269
+ aria-label="Permalink"
270
+ class="tsd-anchor-icon"
271
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
272
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
273
+ ></a>
274
+ </div>
275
+ <div class="tsd-description">
276
+ <div class="tsd-comment tsd-typography">
277
+ <p>Creates a new worker pool</p>
278
+ </div>
279
+ <h4 class="tsd-returns-title">
280
+ Returns
281
+ <a href="" class="tsd-signature-type tsd-kind-class"
282
+ >WorkerPool</a
283
+ >
284
+ </h4>
285
+ <aside class="tsd-sources">
286
+ <p>Overrides EventTarget.constructor</p>
287
+ <ul>
288
+ <li>
289
+ Defined in
290
+ <a
291
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/WorkerPool.ts#L93"
292
+ >WorkerPool.ts:93</a
293
+ >
294
+ </li>
295
+ </ul>
296
+ </aside>
297
+ </div>
298
+ </li>
299
+ </ul>
300
+ </section>
301
+ </section>
302
+ </details>
303
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
304
+ <summary class="tsd-accordion-summary" data-key="section-Accessors">
305
+ <svg
306
+ width="20"
307
+ height="20"
308
+ viewBox="0 0 24 24"
309
+ fill="none"
310
+ aria-hidden="true"
311
+ >
312
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
313
+ </svg>
314
+ <h2>Accessors</h2>
315
+ </summary>
316
+ <section>
317
+ <section class="tsd-panel tsd-member">
318
+ <h3 class="tsd-anchor-link" id="isrunning">
319
+ <span>is<wbr />Running</span
320
+ ><a
321
+ href="#isrunning"
322
+ aria-label="Permalink"
323
+ class="tsd-anchor-icon"
324
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
325
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
326
+ ></a>
327
+ </h3>
328
+ <ul class="tsd-signatures">
329
+ <li>
330
+ <div class="tsd-signature" id="isrunningisrunning">
331
+ <span class="tsd-signature-keyword">get</span>
332
+ <span class="tsd-kind-get-signature">isRunning</span
333
+ ><span class="tsd-signature-symbol">()</span
334
+ ><span class="tsd-signature-symbol">:</span>
335
+ <span class="tsd-signature-type">boolean</span>
336
+ </div>
337
+ <div class="tsd-description">
338
+ <div class="tsd-comment tsd-typography">
339
+ <p>True if the worker is running.</p>
340
+ </div>
341
+ <h4 class="tsd-returns-title">
342
+ Returns <span class="tsd-signature-type">boolean</span>
343
+ </h4>
344
+ <aside class="tsd-sources">
345
+ <ul>
346
+ <li>
347
+ Defined in
348
+ <a
349
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/WorkerPool.ts#L127"
350
+ >WorkerPool.ts:127</a
351
+ >
352
+ </li>
353
+ </ul>
354
+ </aside>
355
+ </div>
356
+ </li>
357
+ </ul>
358
+ </section>
359
+ <section class="tsd-panel tsd-member">
360
+ <h3 class="tsd-anchor-link" id="workerconfig">
361
+ <span>worker<wbr />Config</span
362
+ ><a
363
+ href="#workerconfig"
364
+ aria-label="Permalink"
365
+ class="tsd-anchor-icon"
366
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
367
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
368
+ ></a>
369
+ </h3>
370
+ <ul class="tsd-signatures">
371
+ <li>
372
+ <div class="tsd-signature" id="workerconfigworkerconfig">
373
+ <span class="tsd-signature-keyword">get</span>
374
+ <span class="tsd-kind-get-signature">workerConfig</span
375
+ ><span class="tsd-signature-symbol">()</span
376
+ ><span class="tsd-signature-symbol">:</span>
377
+ <a
378
+ href="../interfaces/host.WorkerConfig.html"
379
+ class="tsd-signature-type tsd-kind-interface"
380
+ >WorkerConfig</a
381
+ >
382
+ </div>
383
+ <div class="tsd-description">
384
+ <div class="tsd-comment tsd-typography">
385
+ <p>Get the configured workers for the pool.</p>
386
+ </div>
387
+ <h4 class="tsd-returns-title">
388
+ Returns
389
+ <a
390
+ href="../interfaces/host.WorkerConfig.html"
391
+ class="tsd-signature-type tsd-kind-interface"
392
+ >WorkerConfig</a
393
+ >
394
+ </h4>
395
+ <aside class="tsd-sources">
396
+ <ul>
397
+ <li>
398
+ Defined in
399
+ <a
400
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/WorkerPool.ts#L120"
401
+ >WorkerPool.ts:120</a
402
+ >
403
+ </li>
404
+ </ul>
405
+ </aside>
406
+ </div>
407
+ </li>
408
+ <li>
409
+ <div class="tsd-signature" id="workerconfigworkerconfig-1">
410
+ <span class="tsd-signature-keyword">set</span>
411
+ <span class="tsd-kind-set-signature">workerConfig</span
412
+ ><span class="tsd-signature-symbol">(</span
413
+ ><span class="tsd-kind-parameter">clientConfig</span
414
+ ><span class="tsd-signature-symbol">:</span>
415
+ <a
416
+ href="../interfaces/host.WorkerConfig.html"
417
+ class="tsd-signature-type tsd-kind-interface"
418
+ >WorkerConfig</a
419
+ ><span class="tsd-signature-symbol">)</span
420
+ ><span class="tsd-signature-symbol">:</span>
421
+ <span class="tsd-signature-type">void</span>
422
+ </div>
423
+ <div class="tsd-description">
424
+ <div class="tsd-comment tsd-typography">
425
+ <p>Set the configured workers for the pool.</p>
426
+ <p>
427
+ Changing this after the pool has been started will throw
428
+ an Error. If you have a need to dynamically change the
429
+ set of running workers, please reach out with your use
430
+ case.
431
+ </p>
432
+ </div>
433
+ <div class="tsd-parameters">
434
+ <h4 class="tsd-parameters-title">Parameters</h4>
435
+ <ul class="tsd-parameter-list">
436
+ <li>
437
+ <span
438
+ ><span class="tsd-kind-parameter">clientConfig</span
439
+ >:
440
+ <a
441
+ href="../interfaces/host.WorkerConfig.html"
442
+ class="tsd-signature-type tsd-kind-interface"
443
+ >WorkerConfig</a
444
+ ></span
445
+ >
446
+ </li>
447
+ </ul>
448
+ </div>
449
+ <h4 class="tsd-returns-title">
450
+ Returns <span class="tsd-signature-type">void</span>
451
+ </h4>
452
+ <aside class="tsd-sources">
453
+ <ul>
454
+ <li>
455
+ Defined in
456
+ <a
457
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/WorkerPool.ts#L106"
458
+ >WorkerPool.ts:106</a
459
+ >
460
+ </li>
461
+ </ul>
462
+ </aside>
463
+ </div>
464
+ </li>
465
+ </ul>
466
+ </section>
467
+ </section>
468
+ </details>
469
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
470
+ <summary class="tsd-accordion-summary" data-key="section-Methods">
471
+ <svg
472
+ width="20"
473
+ height="20"
474
+ viewBox="0 0 24 24"
475
+ fill="none"
476
+ aria-hidden="true"
477
+ >
478
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
479
+ </svg>
480
+ <h2>Methods</h2>
481
+ </summary>
482
+ <section>
483
+ <section class="tsd-panel tsd-member">
484
+ <h3 class="tsd-anchor-link" id="publish">
485
+ <span>publish</span
486
+ ><a
487
+ href="#publish"
488
+ aria-label="Permalink"
489
+ class="tsd-anchor-icon"
490
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
491
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
492
+ ></a>
493
+ </h3>
494
+ <ul class="tsd-signatures">
495
+ <li class="">
496
+ <div class="tsd-signature tsd-anchor-link" id="publish-1">
497
+ <span class="tsd-kind-call-signature">publish</span
498
+ ><span class="tsd-signature-symbol">(</span
499
+ ><span class="tsd-kind-parameter">clientId</span
500
+ ><span class="tsd-signature-symbol">:</span>
501
+ <span class="tsd-signature-type">string</span
502
+ ><span class="tsd-signature-symbol">,</span>
503
+ <span class="tsd-kind-parameter">publication</span
504
+ ><span class="tsd-signature-symbol">:</span>
505
+ <a
506
+ href="../interfaces/messages.Publication.html"
507
+ class="tsd-signature-type tsd-kind-interface"
508
+ >Publication</a
509
+ ><span class="tsd-signature-symbol">)</span
510
+ ><span class="tsd-signature-symbol">:</span>
511
+ <span class="tsd-signature-type">void</span
512
+ ><a
513
+ href="#publish-1"
514
+ aria-label="Permalink"
515
+ class="tsd-anchor-icon"
516
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
517
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
518
+ ></a>
519
+ </div>
520
+ <div class="tsd-description">
521
+ <div class="tsd-comment tsd-typography">
522
+ <p>Publish a message to a worker.</p>
523
+ </div>
524
+ <div class="tsd-parameters">
525
+ <h4 class="tsd-parameters-title">Parameters</h4>
526
+ <ul class="tsd-parameter-list">
527
+ <li>
528
+ <span
529
+ ><span class="tsd-kind-parameter">clientId</span>:
530
+ <span class="tsd-signature-type">string</span></span
531
+ >
532
+ <div class="tsd-comment tsd-typography">
533
+ <p>
534
+ The id of the worker the message should be
535
+ published to
536
+ </p>
537
+ </div>
538
+ </li>
539
+ <li>
540
+ <span
541
+ ><span class="tsd-kind-parameter">publication</span
542
+ >:
543
+ <a
544
+ href="../interfaces/messages.Publication.html"
545
+ class="tsd-signature-type tsd-kind-interface"
546
+ >Publication</a
547
+ ></span
548
+ >
549
+ <div class="tsd-comment tsd-typography">
550
+ <p>
551
+ The information published to the woker. The topic
552
+ may not be of interest, and could be ignored.
553
+ </p>
554
+ </div>
555
+ </li>
556
+ </ul>
557
+ </div>
558
+ <h4 class="tsd-returns-title">
559
+ Returns <span class="tsd-signature-type">void</span>
560
+ </h4>
561
+ <aside class="tsd-sources">
562
+ <ul>
563
+ <li>
564
+ Defined in
565
+ <a
566
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/WorkerPool.ts#L180"
567
+ >WorkerPool.ts:180</a
568
+ >
569
+ </li>
570
+ </ul>
571
+ </aside>
572
+ </div>
573
+ </li>
574
+ </ul>
575
+ </section>
576
+ <section class="tsd-panel tsd-member">
577
+ <h3 class="tsd-anchor-link" id="start">
578
+ <span>start</span
579
+ ><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"
580
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
581
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
582
+ ></a>
583
+ </h3>
584
+ <ul class="tsd-signatures">
585
+ <li class="">
586
+ <div class="tsd-signature tsd-anchor-link" id="start-1">
587
+ <span class="tsd-kind-call-signature">start</span
588
+ ><span class="tsd-signature-symbol">()</span
589
+ ><span class="tsd-signature-symbol">:</span>
590
+ <span class="tsd-signature-type">void</span
591
+ ><a
592
+ href="#start-1"
593
+ aria-label="Permalink"
594
+ class="tsd-anchor-icon"
595
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
596
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
597
+ ></a>
598
+ </div>
599
+ <div class="tsd-description">
600
+ <div class="tsd-comment tsd-typography">
601
+ <p>Start the worker pool, and all associated workers.</p>
602
+ </div>
603
+ <h4 class="tsd-returns-title">
604
+ Returns <span class="tsd-signature-type">void</span>
605
+ </h4>
606
+ <aside class="tsd-sources">
607
+ <ul>
608
+ <li>
609
+ Defined in
610
+ <a
611
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/WorkerPool.ts#L134"
612
+ >WorkerPool.ts:134</a
613
+ >
614
+ </li>
615
+ </ul>
616
+ </aside>
617
+ </div>
618
+ </li>
619
+ </ul>
620
+ </section>
621
+ <section class="tsd-panel tsd-member">
622
+ <h3 class="tsd-anchor-link" id="stop">
623
+ <span>stop</span
624
+ ><a href="#stop" aria-label="Permalink" class="tsd-anchor-icon"
625
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
626
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
627
+ ></a>
628
+ </h3>
629
+ <ul class="tsd-signatures">
630
+ <li class="">
631
+ <div class="tsd-signature tsd-anchor-link" id="stop-1">
632
+ <span class="tsd-kind-call-signature">stop</span
633
+ ><span class="tsd-signature-symbol">()</span
634
+ ><span class="tsd-signature-symbol">:</span>
635
+ <span class="tsd-signature-type">void</span
636
+ ><a
637
+ href="#stop-1"
638
+ aria-label="Permalink"
639
+ class="tsd-anchor-icon"
640
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
641
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
642
+ ></a>
643
+ </div>
644
+ <div class="tsd-description">
645
+ <div class="tsd-comment tsd-typography">
646
+ <p>
647
+ Stops the worker pool, immediately terminating all
648
+ registered workers. Does nothing if the pool was never
649
+ started.
650
+ </p>
651
+ </div>
652
+ <h4 class="tsd-returns-title">
653
+ Returns <span class="tsd-signature-type">void</span>
654
+ </h4>
655
+ <aside class="tsd-sources">
656
+ <ul>
657
+ <li>
658
+ Defined in
659
+ <a
660
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/WorkerPool.ts#L160"
661
+ >WorkerPool.ts:160</a
662
+ >
663
+ </li>
664
+ </ul>
665
+ </aside>
666
+ </div>
667
+ </li>
668
+ </ul>
669
+ </section>
670
+ </section>
671
+ </details>
672
+ </div>
673
+ <div class="col-sidebar">
674
+ <div class="page-menu">
675
+ <div class="tsd-navigation settings">
676
+ <details class="tsd-accordion">
677
+ <summary class="tsd-accordion-summary">
678
+ <svg
679
+ width="20"
680
+ height="20"
681
+ viewBox="0 0 24 24"
682
+ fill="none"
683
+ aria-hidden="true"
684
+ >
685
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
686
+ </svg>
687
+ <h3>Settings</h3>
688
+ </summary>
689
+ <div class="tsd-accordion-details">
690
+ <div class="tsd-filter-visibility">
691
+ <span class="settings-label">Member Visibility</span>
692
+ <ul id="tsd-filter-options">
693
+ <li class="tsd-filter-item">
694
+ <label class="tsd-filter-input"
695
+ ><input
696
+ type="checkbox"
697
+ id="tsd-filter-inherited"
698
+ name="inherited"
699
+ checked
700
+ /><svg
701
+ width="32"
702
+ height="32"
703
+ viewBox="0 0 32 32"
704
+ aria-hidden="true"
705
+ >
706
+ <rect
707
+ class="tsd-checkbox-background"
708
+ width="30"
709
+ height="30"
710
+ x="1"
711
+ y="1"
712
+ rx="6"
713
+ fill="none"
714
+ ></rect>
715
+ <path
716
+ class="tsd-checkbox-checkmark"
717
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
718
+ stroke="none"
719
+ stroke-width="3.5"
720
+ stroke-linejoin="round"
721
+ fill="none"
722
+ ></path></svg
723
+ ><span>Inherited</span></label
724
+ >
725
+ </li>
726
+ </ul>
727
+ </div>
728
+ <div class="tsd-theme-toggle">
729
+ <label class="settings-label" for="tsd-theme">Theme</label
730
+ ><select id="tsd-theme">
731
+ <option value="os">OS</option>
732
+ <option value="light">Light</option>
733
+ <option value="dark">Dark</option>
734
+ </select>
735
+ </div>
736
+ </div>
737
+ </details>
738
+ </div>
739
+ <details open class="tsd-accordion tsd-page-navigation">
740
+ <summary class="tsd-accordion-summary">
741
+ <svg
742
+ width="20"
743
+ height="20"
744
+ viewBox="0 0 24 24"
745
+ fill="none"
746
+ aria-hidden="true"
747
+ >
748
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
749
+ </svg>
750
+ <h3>On This Page</h3>
751
+ </summary>
752
+ <div class="tsd-accordion-details">
753
+ <details open class="tsd-accordion tsd-page-navigation-section">
754
+ <summary
755
+ class="tsd-accordion-summary"
756
+ data-key="section-Constructors"
757
+ >
758
+ <svg
759
+ width="20"
760
+ height="20"
761
+ viewBox="0 0 24 24"
762
+ fill="none"
763
+ aria-hidden="true"
764
+ >
765
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
766
+ >Constructors
767
+ </summary>
768
+ <div>
769
+ <a href="#constructor"
770
+ ><svg
771
+ class="tsd-kind-icon"
772
+ viewBox="0 0 24 24"
773
+ aria-label="Constructor"
774
+ >
775
+ <use href="../assets/icons.svg#icon-512"></use></svg
776
+ ><span>constructor</span></a
777
+ >
778
+ </div>
779
+ </details>
780
+ <details open class="tsd-accordion tsd-page-navigation-section">
781
+ <summary
782
+ class="tsd-accordion-summary"
783
+ data-key="section-Accessors"
784
+ >
785
+ <svg
786
+ width="20"
787
+ height="20"
788
+ viewBox="0 0 24 24"
789
+ fill="none"
790
+ aria-hidden="true"
791
+ >
792
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
793
+ >Accessors
794
+ </summary>
795
+ <div>
796
+ <a href="#isrunning"
797
+ ><svg
798
+ class="tsd-kind-icon"
799
+ viewBox="0 0 24 24"
800
+ aria-label="Accessor"
801
+ >
802
+ <use href="../assets/icons.svg#icon-262144"></use></svg
803
+ ><span>is<wbr />Running</span></a
804
+ ><a href="#workerconfig"
805
+ ><svg
806
+ class="tsd-kind-icon"
807
+ viewBox="0 0 24 24"
808
+ aria-label="Accessor"
809
+ >
810
+ <use href="../assets/icons.svg#icon-262144"></use></svg
811
+ ><span>worker<wbr />Config</span></a
812
+ >
813
+ </div>
814
+ </details>
815
+ <details open class="tsd-accordion tsd-page-navigation-section">
816
+ <summary
817
+ class="tsd-accordion-summary"
818
+ data-key="section-Methods"
819
+ >
820
+ <svg
821
+ width="20"
822
+ height="20"
823
+ viewBox="0 0 24 24"
824
+ fill="none"
825
+ aria-hidden="true"
826
+ >
827
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
828
+ >Methods
829
+ </summary>
830
+ <div>
831
+ <a href="#publish"
832
+ ><svg
833
+ class="tsd-kind-icon"
834
+ viewBox="0 0 24 24"
835
+ aria-label="Method"
836
+ >
837
+ <use href="../assets/icons.svg#icon-2048"></use></svg
838
+ ><span>publish</span></a
839
+ ><a href="#start"
840
+ ><svg
841
+ class="tsd-kind-icon"
842
+ viewBox="0 0 24 24"
843
+ aria-label="Method"
844
+ >
845
+ <use href="../assets/icons.svg#icon-2048"></use></svg
846
+ ><span>start</span></a
847
+ ><a href="#stop"
848
+ ><svg
849
+ class="tsd-kind-icon"
850
+ viewBox="0 0 24 24"
851
+ aria-label="Method"
852
+ >
853
+ <use href="../assets/icons.svg#icon-2048"></use></svg
854
+ ><span>stop</span></a
855
+ >
856
+ </div>
857
+ </details>
858
+ </div>
859
+ </details>
860
+ </div>
861
+ <div class="site-menu">
862
+ <nav class="tsd-navigation">
863
+ <a href="../modules.html">iframe-coordinator - v6.5.1</a>
864
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
865
+ <li>Loading...</li>
866
+ </ul>
867
+ </nav>
868
+ </div>
869
+ </div>
870
+ </div>
871
+ <footer>
872
+ <p class="tsd-generator">
873
+ Generated using
874
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
875
+ </p>
876
+ </footer>
877
+ <div class="overlay"></div>
878
+ </body>
879
+ </html>