iframe-coordinator-cli 6.4.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 (57) hide show
  1. package/dist/assets/index-DEUCFuke.css +1 -0
  2. package/dist/assets/index-DejhDHus.js +57 -0
  3. package/dist/favicon.svg +1 -0
  4. package/dist/ifc-docs/assets/hierarchy.js +1 -1
  5. package/dist/ifc-docs/assets/highlight.css +130 -91
  6. package/dist/ifc-docs/assets/icons.js +20 -17
  7. package/dist/ifc-docs/assets/icons.svg +1 -1
  8. package/dist/ifc-docs/assets/main.js +2535 -5
  9. package/dist/ifc-docs/assets/navigation.js +2 -1
  10. package/dist/ifc-docs/assets/search.js +2 -1
  11. package/dist/ifc-docs/assets/style.css +1571 -1581
  12. package/dist/ifc-docs/classes/client.Client.html +2388 -99
  13. package/dist/ifc-docs/classes/client.WorkerClient.html +2164 -0
  14. package/dist/ifc-docs/classes/host.FrameRouterElement.html +850 -24
  15. package/dist/ifc-docs/classes/host.WorkerPool.html +879 -0
  16. package/dist/ifc-docs/documents/client-setup.html +579 -75
  17. package/dist/ifc-docs/functions/host.registerCustomElements.html +218 -3
  18. package/dist/ifc-docs/hierarchy.html +168 -1
  19. package/dist/ifc-docs/index.html +432 -31
  20. package/dist/ifc-docs/interfaces/client.ClientConfigOptions.html +331 -4
  21. package/dist/ifc-docs/interfaces/client.EventEmitter.html +752 -0
  22. package/dist/ifc-docs/interfaces/host.ClientConfig.html +399 -7
  23. package/dist/ifc-docs/interfaces/host.ClientRegistration.html +580 -24
  24. package/dist/ifc-docs/interfaces/host.RoutingMap.html +211 -4
  25. package/dist/ifc-docs/interfaces/host.WorkerAppData.html +388 -0
  26. package/dist/ifc-docs/interfaces/host.WorkerConfig.html +398 -0
  27. package/dist/ifc-docs/interfaces/host.WorkerItem.html +401 -0
  28. package/dist/ifc-docs/interfaces/host.WorkerRegistry.html +210 -0
  29. package/dist/ifc-docs/interfaces/messages.Breadcrumb.html +373 -0
  30. package/dist/ifc-docs/interfaces/messages.EnvData.html +510 -0
  31. package/dist/ifc-docs/interfaces/messages.KeyData.html +540 -0
  32. package/dist/ifc-docs/interfaces/messages.ModalRequest.html +381 -0
  33. package/dist/ifc-docs/interfaces/messages.NavRequest.html +390 -0
  34. package/dist/ifc-docs/interfaces/messages.Notification.html +435 -0
  35. package/dist/ifc-docs/interfaces/messages.PageMetadata.html +438 -0
  36. package/dist/ifc-docs/interfaces/messages.PromptOnLeave.html +390 -0
  37. package/dist/ifc-docs/interfaces/messages.Publication.html +443 -0
  38. package/dist/ifc-docs/modules/client.html +742 -2
  39. package/dist/ifc-docs/modules/host.html +647 -1
  40. package/dist/ifc-docs/modules/messages.html +462 -0
  41. package/dist/ifc-docs/modules.html +359 -1
  42. package/dist/ifc-docs/types/client.EnvDataHandler.html +239 -5
  43. package/dist/ifc-docs/types/client.EventHandler.html +247 -2
  44. package/dist/index.html +3 -3
  45. package/package.json +3 -4
  46. package/dist/assets/index-BLdxgMq2.css +0 -1
  47. package/dist/assets/index-IcxzuslN.js +0 -49
  48. package/dist/ifc-docs/classes/client.EventEmitter.html +0 -14
  49. package/dist/ifc-docs/interfaces/client.Breadcrumb.html +0 -6
  50. package/dist/ifc-docs/interfaces/client.EnvData.html +0 -11
  51. package/dist/ifc-docs/interfaces/client.KeyData.html +0 -12
  52. package/dist/ifc-docs/interfaces/client.ModalRequest.html +0 -6
  53. package/dist/ifc-docs/interfaces/client.NavRequest.html +0 -9
  54. package/dist/ifc-docs/interfaces/client.Notification.html +0 -9
  55. package/dist/ifc-docs/interfaces/client.PageMetadata.html +0 -8
  56. package/dist/ifc-docs/interfaces/client.PromptOnLeave.html +0 -9
  57. package/dist/ifc-docs/interfaces/client.Publication.html +0 -11
@@ -0,0 +1,398 @@
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>WorkerConfig | 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">WorkerConfig</a></li>
84
+ </ul>
85
+ <h1>Interface WorkerConfig</h1>
86
+ </div>
87
+ <section class="tsd-panel tsd-comment">
88
+ <div class="tsd-comment tsd-typography">
89
+ <p>
90
+ Data structure defining the list of web workers, and any
91
+ environmental data they may need for initialization.
92
+ </p>
93
+ </div>
94
+ </section>
95
+ <div class="tsd-signature">
96
+ <span class="tsd-signature-keyword">interface</span>
97
+ <span class="tsd-kind-interface">WorkerConfig</span>
98
+ <span class="tsd-signature-symbol">{</span><br />    <a
99
+ class="tsd-kind-property"
100
+ href="#clients"
101
+ >clients</a
102
+ ><span class="tsd-signature-symbol">:</span>
103
+ <a
104
+ href="host.WorkerRegistry.html"
105
+ class="tsd-signature-type tsd-kind-interface"
106
+ >WorkerRegistry</a
107
+ ><span class="tsd-signature-symbol">;</span><br />    <a
108
+ class="tsd-kind-property"
109
+ href="#envdata"
110
+ >envData</a
111
+ ><span class="tsd-signature-symbol">:</span>
112
+ <a
113
+ href="messages.EnvData.html"
114
+ class="tsd-signature-type tsd-kind-interface"
115
+ >EnvData</a
116
+ ><span class="tsd-signature-symbol">;</span><br /><span
117
+ class="tsd-signature-symbol"
118
+ >}</span
119
+ >
120
+ </div>
121
+ <aside class="tsd-sources">
122
+ <ul>
123
+ <li>
124
+ Defined in
125
+ <a
126
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/WorkerPool.ts#L10"
127
+ >WorkerPool.ts:10</a
128
+ >
129
+ </li>
130
+ </ul>
131
+ </aside>
132
+ <section class="tsd-panel-group tsd-index-group">
133
+ <section class="tsd-panel tsd-index-panel">
134
+ <details class="tsd-index-content tsd-accordion" open>
135
+ <summary class="tsd-accordion-summary tsd-index-summary">
136
+ <svg
137
+ width="20"
138
+ height="20"
139
+ viewBox="0 0 24 24"
140
+ fill="none"
141
+ aria-hidden="true"
142
+ >
143
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
144
+ </svg>
145
+ <h5 class="tsd-index-heading uppercase">Index</h5>
146
+ </summary>
147
+ <div class="tsd-accordion-details">
148
+ <section class="tsd-index-section">
149
+ <h3 class="tsd-index-heading">Properties</h3>
150
+ <div class="tsd-index-list">
151
+ <a href="#clients" class="tsd-index-link"
152
+ ><svg
153
+ class="tsd-kind-icon"
154
+ viewBox="0 0 24 24"
155
+ aria-label="Property"
156
+ >
157
+ <use href="../assets/icons.svg#icon-1024"></use></svg
158
+ ><span>clients</span></a
159
+ >
160
+ <a href="#envdata" class="tsd-index-link"
161
+ ><svg
162
+ class="tsd-kind-icon"
163
+ viewBox="0 0 24 24"
164
+ aria-label="Property"
165
+ >
166
+ <use href="../assets/icons.svg#icon-1024"></use></svg
167
+ ><span>env<wbr />Data</span></a
168
+ >
169
+ </div>
170
+ </section>
171
+ </div>
172
+ </details>
173
+ </section>
174
+ </section>
175
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
176
+ <summary class="tsd-accordion-summary" data-key="section-Properties">
177
+ <svg
178
+ width="20"
179
+ height="20"
180
+ viewBox="0 0 24 24"
181
+ fill="none"
182
+ aria-hidden="true"
183
+ >
184
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
185
+ </svg>
186
+ <h2>Properties</h2>
187
+ </summary>
188
+ <section>
189
+ <section class="tsd-panel tsd-member">
190
+ <h3 class="tsd-anchor-link" id="clients">
191
+ <span>clients</span
192
+ ><a
193
+ href="#clients"
194
+ aria-label="Permalink"
195
+ class="tsd-anchor-icon"
196
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
197
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
198
+ ></a>
199
+ </h3>
200
+ <div class="tsd-signature">
201
+ <span class="tsd-kind-property">clients</span
202
+ ><span class="tsd-signature-symbol">:</span>
203
+ <a
204
+ href="host.WorkerRegistry.html"
205
+ class="tsd-signature-type tsd-kind-interface"
206
+ >WorkerRegistry</a
207
+ >
208
+ </div>
209
+ <div class="tsd-comment tsd-typography">
210
+ <p>Web worker registrations</p>
211
+ </div>
212
+ <aside class="tsd-sources">
213
+ <ul>
214
+ <li>
215
+ Defined in
216
+ <a
217
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/WorkerPool.ts#L12"
218
+ >WorkerPool.ts:12</a
219
+ >
220
+ </li>
221
+ </ul>
222
+ </aside>
223
+ </section>
224
+ <section class="tsd-panel tsd-member">
225
+ <h3 class="tsd-anchor-link" id="envdata">
226
+ <span>env<wbr />Data</span
227
+ ><a
228
+ href="#envdata"
229
+ aria-label="Permalink"
230
+ class="tsd-anchor-icon"
231
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
232
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
233
+ ></a>
234
+ </h3>
235
+ <div class="tsd-signature">
236
+ <span class="tsd-kind-property">envData</span
237
+ ><span class="tsd-signature-symbol">:</span>
238
+ <a
239
+ href="messages.EnvData.html"
240
+ class="tsd-signature-type tsd-kind-interface"
241
+ >EnvData</a
242
+ >
243
+ </div>
244
+ <div class="tsd-comment tsd-typography">
245
+ <p>Information about the host environment.</p>
246
+ </div>
247
+ <aside class="tsd-sources">
248
+ <ul>
249
+ <li>
250
+ Defined in
251
+ <a
252
+ href="https://github.com/purecloudlabs/iframe-coordinator/blob/c66985bfb186111ea5faaed3c49c76f23c1e0800/packages/iframe-coordinator/src/WorkerPool.ts#L14"
253
+ >WorkerPool.ts:14</a
254
+ >
255
+ </li>
256
+ </ul>
257
+ </aside>
258
+ </section>
259
+ </section>
260
+ </details>
261
+ </div>
262
+ <div class="col-sidebar">
263
+ <div class="page-menu">
264
+ <div class="tsd-navigation settings">
265
+ <details class="tsd-accordion">
266
+ <summary class="tsd-accordion-summary">
267
+ <svg
268
+ width="20"
269
+ height="20"
270
+ viewBox="0 0 24 24"
271
+ fill="none"
272
+ aria-hidden="true"
273
+ >
274
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
275
+ </svg>
276
+ <h3>Settings</h3>
277
+ </summary>
278
+ <div class="tsd-accordion-details">
279
+ <div class="tsd-filter-visibility">
280
+ <span class="settings-label">Member Visibility</span>
281
+ <ul id="tsd-filter-options">
282
+ <li class="tsd-filter-item">
283
+ <label class="tsd-filter-input"
284
+ ><input
285
+ type="checkbox"
286
+ id="tsd-filter-inherited"
287
+ name="inherited"
288
+ checked
289
+ /><svg
290
+ width="32"
291
+ height="32"
292
+ viewBox="0 0 32 32"
293
+ aria-hidden="true"
294
+ >
295
+ <rect
296
+ class="tsd-checkbox-background"
297
+ width="30"
298
+ height="30"
299
+ x="1"
300
+ y="1"
301
+ rx="6"
302
+ fill="none"
303
+ ></rect>
304
+ <path
305
+ class="tsd-checkbox-checkmark"
306
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
307
+ stroke="none"
308
+ stroke-width="3.5"
309
+ stroke-linejoin="round"
310
+ fill="none"
311
+ ></path></svg
312
+ ><span>Inherited</span></label
313
+ >
314
+ </li>
315
+ </ul>
316
+ </div>
317
+ <div class="tsd-theme-toggle">
318
+ <label class="settings-label" for="tsd-theme">Theme</label
319
+ ><select id="tsd-theme">
320
+ <option value="os">OS</option>
321
+ <option value="light">Light</option>
322
+ <option value="dark">Dark</option>
323
+ </select>
324
+ </div>
325
+ </div>
326
+ </details>
327
+ </div>
328
+ <details open class="tsd-accordion tsd-page-navigation">
329
+ <summary class="tsd-accordion-summary">
330
+ <svg
331
+ width="20"
332
+ height="20"
333
+ viewBox="0 0 24 24"
334
+ fill="none"
335
+ aria-hidden="true"
336
+ >
337
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
338
+ </svg>
339
+ <h3>On This Page</h3>
340
+ </summary>
341
+ <div class="tsd-accordion-details">
342
+ <details open class="tsd-accordion tsd-page-navigation-section">
343
+ <summary
344
+ class="tsd-accordion-summary"
345
+ data-key="section-Properties"
346
+ >
347
+ <svg
348
+ width="20"
349
+ height="20"
350
+ viewBox="0 0 24 24"
351
+ fill="none"
352
+ aria-hidden="true"
353
+ >
354
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
355
+ >Properties
356
+ </summary>
357
+ <div>
358
+ <a href="#clients"
359
+ ><svg
360
+ class="tsd-kind-icon"
361
+ viewBox="0 0 24 24"
362
+ aria-label="Property"
363
+ >
364
+ <use href="../assets/icons.svg#icon-1024"></use></svg
365
+ ><span>clients</span></a
366
+ ><a href="#envdata"
367
+ ><svg
368
+ class="tsd-kind-icon"
369
+ viewBox="0 0 24 24"
370
+ aria-label="Property"
371
+ >
372
+ <use href="../assets/icons.svg#icon-1024"></use></svg
373
+ ><span>env<wbr />Data</span></a
374
+ >
375
+ </div>
376
+ </details>
377
+ </div>
378
+ </details>
379
+ </div>
380
+ <div class="site-menu">
381
+ <nav class="tsd-navigation">
382
+ <a href="../modules.html">iframe-coordinator - v6.5.1</a>
383
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
384
+ <li>Loading...</li>
385
+ </ul>
386
+ </nav>
387
+ </div>
388
+ </div>
389
+ </div>
390
+ <footer>
391
+ <p class="tsd-generator">
392
+ Generated using
393
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
394
+ </p>
395
+ </footer>
396
+ <div class="overlay"></div>
397
+ </body>
398
+ </html>