spyne 0.19.1 → 0.20.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 (132) hide show
  1. package/.eslintignore +2 -0
  2. package/.eslintrc.js +4 -3
  3. package/.travis.yml +24 -11
  4. package/karma.conf.js +77 -87
  5. package/lib/spyne.esm.js +15 -0
  6. package/lib/spyne.esm.js.map +1 -0
  7. package/lib/spyne.js +248 -248
  8. package/lib/spyne.umd.js +3 -0
  9. package/lib/spyne.umd.js.LICENSE.txt +16 -0
  10. package/package.json +48 -27
  11. package/rollup.config.js +26 -0
  12. package/src/spyne/channels/channel-fetch-class.js +39 -43
  13. package/src/spyne/channels/channel-payload-class.js +61 -74
  14. package/src/spyne/channels/channel-proxy.js +25 -26
  15. package/src/spyne/channels/channel.js +141 -149
  16. package/src/spyne/channels/channels-config.js +46 -47
  17. package/src/spyne/channels/channels-map.js +61 -65
  18. package/src/spyne/channels/spyne-channel-lifecycle.js +12 -12
  19. package/src/spyne/channels/spyne-channel-route.js +241 -250
  20. package/src/spyne/channels/spyne-channel-ui.js +213 -75
  21. package/src/spyne/channels/spyne-channel-window.js +157 -157
  22. package/src/spyne/spyne-app.js +32 -19
  23. package/src/spyne/spyne-plugins.js +55 -70
  24. package/src/spyne/spyne.js +23 -23
  25. package/src/spyne/utils/channel-config-validator.js +10 -10
  26. package/src/spyne/utils/channel-fetch-util.js +72 -55
  27. package/src/spyne/utils/channel-payload-filter.js +89 -100
  28. package/src/spyne/utils/deep-merge.js +31 -29
  29. package/src/spyne/utils/frp-tools.js +108 -92
  30. package/src/spyne/utils/gc.js +6 -6
  31. package/src/spyne/utils/mixins/base-core-mixins.js +17 -15
  32. package/src/spyne/utils/mixins/base-streams-mixins.js +9 -9
  33. package/src/spyne/utils/route-channel-updater.js +23 -29
  34. package/src/spyne/utils/safe-clone.js +40 -58
  35. package/src/spyne/utils/sanitize-html.js +35 -0
  36. package/src/spyne/utils/security-policy.js +11 -0
  37. package/src/spyne/utils/spyne-app-properties.js +110 -114
  38. package/src/spyne/utils/spyne-logger.js +4 -11
  39. package/src/spyne/utils/spyne-plugins-methods.js +38 -63
  40. package/src/spyne/utils/spyne-trait.js +33 -33
  41. package/src/spyne/utils/spyne-utils-channel-route-url.js +229 -153
  42. package/src/spyne/utils/spyne-utils-channel-route.js +128 -138
  43. package/src/spyne/utils/spyne-utils-channel-window.js +39 -39
  44. package/src/spyne/utils/viewstream-animations.js +12 -12
  45. package/src/spyne/utils/viewstream-observables.js +45 -45
  46. package/src/spyne/views/dom-element-template.js +111 -114
  47. package/src/spyne/views/dom-element.js +82 -84
  48. package/src/spyne/views/view-stream-broadcaster.js +66 -62
  49. package/src/spyne/views/view-stream-element.js +105 -106
  50. package/src/spyne/views/view-stream-payload.js +25 -27
  51. package/src/spyne/views/view-stream-selector.js +157 -163
  52. package/src/spyne/views/view-stream.js +416 -640
  53. package/src/tests/channels/channel-dom.test.js +15 -15
  54. package/src/tests/channels/channel-fetch.test.js +51 -62
  55. package/src/tests/channels/channel-payload-class.test.js +50 -63
  56. package/src/tests/channels/channel-payload-filter.test.js +133 -193
  57. package/src/tests/channels/channel-route.test.js +102 -112
  58. package/src/tests/channels/channel-stream-item.test.js +19 -19
  59. package/src/tests/channels/channel-ui.test.js +15 -27
  60. package/src/tests/channels/channel-util-dom.test.js +31 -31
  61. package/src/tests/channels/channel.test.js +20 -25
  62. package/src/tests/channels/route-utils.test.js +61 -66
  63. package/src/tests/channels/url-utils.test.js +151 -151
  64. package/src/tests/channels/view-stream-broadcaster.test.js +7 -7
  65. package/src/tests/import.test.js +5 -5
  66. package/src/tests/index.js +6 -7
  67. package/src/tests/index.test.js +6 -8
  68. package/src/tests/mocks/channel-payload-data.js +218 -220
  69. package/src/tests/mocks/enhancer.test.js +5 -5
  70. package/src/tests/mocks/payload-ui.js +87 -90
  71. package/src/tests/mocks/routes-data.js +264 -266
  72. package/src/tests/mocks/spyne-docs.mocks.js +3 -3
  73. package/src/tests/mocks/template-renderer.mocks.js +47 -47
  74. package/src/tests/mocks/utils-data.js +78 -79
  75. package/src/tests/mocks/viewstream-internal-payload.mocks.js +50 -50
  76. package/src/tests/mocks/window-events-arr.js +1 -1
  77. package/src/tests/package-json.spec.test.js +9 -0
  78. package/src/tests/spyne-app.test.js +15 -18
  79. package/src/tests/spyne-plugin.test.js +16 -20
  80. package/src/tests/utils/channel-action-filter.test.js +84 -86
  81. package/src/tests/utils/channel-data-packet-generator.unused.js +62 -86
  82. package/src/tests/utils/channel-fetch-util.test.js +64 -66
  83. package/src/tests/utils/frp-tools.test.js +19 -19
  84. package/src/tests/utils/plugins-methods.test.js +31 -55
  85. package/src/tests/utils/security.test.js +10 -0
  86. package/src/tests/utils/spyne-app-properties.test.js +4 -8
  87. package/src/tests/views/dom-el-selectors.test.js +112 -119
  88. package/src/tests/views/dom-el-template-proxy.test.js +7 -0
  89. package/src/tests/views/dom-el-template.test.js +186 -156
  90. package/src/tests/views/dom-el.test.js +58 -56
  91. package/src/tests/views/view-stream-enhancer-loader.test.js +2 -2
  92. package/src/tests/views/view-stream-enhancer.test.js +11 -11
  93. package/src/tests/views/view-stream.test.js +22 -33
  94. package/webpack.config.js +76 -67
  95. package/docs/-_%20Solves%20equations%20of%20the%20form%20a%20_%20x%20=%20b.html +0 -487
  96. package/docs/DomItem.html +0 -298
  97. package/docs/DomItem_DomItem.html +0 -314
  98. package/docs/ViewStream.html +0 -2249
  99. package/docs/ViewStream_ViewStream.html +0 -503
  100. package/docs/custom/css/jsdoc-viewstream.css +0 -377
  101. package/docs/custom/layout.tmpl +0 -47
  102. package/docs/dom-item.js.html +0 -213
  103. package/docs/fonts/OpenSans-Bold-webfont.eot +0 -0
  104. package/docs/fonts/OpenSans-Bold-webfont.svg +0 -1830
  105. package/docs/fonts/OpenSans-Bold-webfont.woff +0 -0
  106. package/docs/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  107. package/docs/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
  108. package/docs/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  109. package/docs/fonts/OpenSans-Italic-webfont.eot +0 -0
  110. package/docs/fonts/OpenSans-Italic-webfont.svg +0 -1830
  111. package/docs/fonts/OpenSans-Italic-webfont.woff +0 -0
  112. package/docs/fonts/OpenSans-Light-webfont.eot +0 -0
  113. package/docs/fonts/OpenSans-Light-webfont.svg +0 -1831
  114. package/docs/fonts/OpenSans-Light-webfont.woff +0 -0
  115. package/docs/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  116. package/docs/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
  117. package/docs/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  118. package/docs/fonts/OpenSans-Regular-webfont.eot +0 -0
  119. package/docs/fonts/OpenSans-Regular-webfont.svg +0 -1831
  120. package/docs/fonts/OpenSans-Regular-webfont.woff +0 -0
  121. package/docs/global.html +0 -548
  122. package/docs/index-custom.html +0 -79
  123. package/docs/index.html +0 -82
  124. package/docs/jsdoc.config.json +0 -22
  125. package/docs/scripts/linenumber.js +0 -25
  126. package/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
  127. package/docs/scripts/prettify/lang-css.js +0 -2
  128. package/docs/scripts/prettify/prettify.js +0 -28
  129. package/docs/styles/jsdoc-default.css +0 -358
  130. package/docs/styles/prettify-jsdoc.css +0 -111
  131. package/docs/styles/prettify-tomorrow.css +0 -132
  132. package/docs/view-stream.js.html +0 -767
@@ -1,2249 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Class: ViewStream</title>
6
- <link href="https://fonts.googleapis.com/css?family=Roboto+Slab" rel="stylesheet">
7
-
8
- <script src="scripts/prettify/prettify.js"> </script>
9
- <script src="scripts/prettify/lang-css.js"> </script>
10
- <!--[if lt IE 9]>
11
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
12
- <![endif]-->
13
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
14
- <!--
15
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
16
- -->
17
- <link type="text/css" rel="stylesheet" href="custom/css/jsdoc-viewstream.css">
18
-
19
-
20
- </head>
21
-
22
- <body>
23
-
24
- <div id="main">
25
- <a class="page-title spyne" href='https://www.npmjs.com/package/spyne' target='blank'>spyne</a>
26
-
27
- <!--
28
- <h1 class="page-title">Class: ViewStream</h1>
29
- -->
30
-
31
-
32
-
33
-
34
-
35
-
36
- <section>
37
-
38
- <header>
39
-
40
- <h2><span class="attribs"><span class="type-signature"></span></span>ViewStream<span class="signature">(props)</span><span class="type-signature"></span></h2>
41
-
42
-
43
- </header>
44
-
45
- <article>
46
- <div class="container-overview">
47
-
48
-
49
-
50
-
51
-
52
-
53
- <h4 class="name" id="ViewStream"><span class="type-signature"></span>new ViewStream<span class="signature">(props)</span><span class="type-signature"></span></h4>
54
-
55
-
56
-
57
-
58
-
59
-
60
- <div class="description">
61
- <p>The ViewStream object creates or references a dom elment; the dom element can be as simple as a &#60;p&gt; tag, or the dom element can be a large dom chunk that is generated from data and an html template.
62
- <br><br>
63
- Generally, the idea is to extend the ViewStream class and add the custom values within the constructor function, but all of the values can be passed as parameters as well.</p>
64
- </div>
65
-
66
-
67
-
68
-
69
-
70
-
71
-
72
-
73
-
74
- <h5>Parameters:</h5>
75
-
76
-
77
- <table class="params">
78
- <thead>
79
- <tr>
80
-
81
- <th>Name</th>
82
-
83
-
84
- <th>Type</th>
85
-
86
-
87
-
88
-
89
-
90
- <th class="last">Description</th>
91
- </tr>
92
- </thead>
93
-
94
- <tbody>
95
-
96
-
97
- <tr>
98
-
99
- <td class="name"><code>props</code></td>
100
-
101
-
102
- <td class="type">
103
-
104
-
105
- <span class="param-type">object</span>
106
-
107
-
108
-
109
- </td>
110
-
111
-
112
-
113
-
114
-
115
- <td class="description last"><p>This json object takes in parameters to generate or reference the dom element</p></td>
116
- </tr>
117
-
118
-
119
- </tbody>
120
- </table>
121
-
122
-
123
-
124
-
125
-
126
-
127
- <h5 class="subsection-title">Properties:</h5>
128
-
129
-
130
-
131
- <table class="props">
132
- <thead>
133
- <tr>
134
-
135
- <th>Name</th>
136
-
137
-
138
- <th>Type</th>
139
-
140
-
141
-
142
-
143
-
144
- <th class="last">Description</th>
145
- </tr>
146
- </thead>
147
-
148
- <tbody>
149
-
150
-
151
- <tr>
152
-
153
- <td class="name"><code>props.tagName</code></td>
154
-
155
-
156
- <td class="type">
157
-
158
-
159
- <span class="param-type">string</span>
160
-
161
-
162
-
163
- </td>
164
-
165
-
166
-
167
-
168
-
169
- <td class="description last"><p>'div' This can be any dom tag</p></td>
170
- </tr>
171
-
172
-
173
-
174
- <tr>
175
-
176
- <td class="name"><code>props.el</code></td>
177
-
178
-
179
- <td class="type">
180
-
181
-
182
- <span class="param-type">domItem</span>
183
-
184
-
185
-
186
- </td>
187
-
188
-
189
-
190
-
191
-
192
- <td class="description last"><p>undefined, if defined, ViewStream will connect to that element</p></td>
193
- </tr>
194
-
195
-
196
-
197
- <tr>
198
-
199
- <td class="name"><code>props.data</code></td>
200
-
201
-
202
- <td class="type">
203
-
204
-
205
- <span class="param-type">string</span>
206
- |
207
-
208
- <span class="param-type">object</span>
209
-
210
-
211
-
212
- </td>
213
-
214
-
215
-
216
-
217
-
218
- <td class="description last"><p>undefined, // string for innerText or Json object for html template</p></td>
219
- </tr>
220
-
221
-
222
-
223
- <tr>
224
-
225
- <td class="name"><code>props.animateIn</code></td>
226
-
227
-
228
- <td class="type">
229
-
230
-
231
- <span class="param-type">boolean</span>
232
-
233
-
234
-
235
- </td>
236
-
237
-
238
-
239
-
240
-
241
- <td class="description last"><p>false, animates in View</p></td>
242
- </tr>
243
-
244
-
245
-
246
- <tr>
247
-
248
- <td class="name"><code>props.animateInTime</code></td>
249
-
250
-
251
- <td class="type">
252
-
253
-
254
- <span class="param-type">number</span>
255
-
256
-
257
-
258
- </td>
259
-
260
-
261
-
262
-
263
-
264
- <td class="description last"><p>.5</p></td>
265
- </tr>
266
-
267
-
268
-
269
- <tr>
270
-
271
- <td class="name"><code>props.animateOut</code></td>
272
-
273
-
274
- <td class="type">
275
-
276
-
277
- <span class="param-type">boolean</span>
278
-
279
-
280
-
281
- </td>
282
-
283
-
284
-
285
-
286
-
287
- <td class="description last"><p>false, animates in View</p></td>
288
- </tr>
289
-
290
-
291
-
292
- <tr>
293
-
294
- <td class="name"><code>props.animateOutTime</code></td>
295
-
296
-
297
- <td class="type">
298
-
299
-
300
- <span class="param-type">number</span>
301
-
302
-
303
-
304
- </td>
305
-
306
-
307
-
308
-
309
-
310
- <td class="description last"><p>.5</p></td>
311
- </tr>
312
-
313
-
314
-
315
- <tr>
316
-
317
- <td class="name"><code>props.id</code></td>
318
-
319
-
320
- <td class="type">
321
-
322
-
323
- <span class="param-type">string</span>
324
-
325
-
326
-
327
- </td>
328
-
329
-
330
-
331
-
332
-
333
- <td class="description last"><p>undefined, generates a random id if left undefined</p></td>
334
- </tr>
335
-
336
-
337
-
338
- <tr>
339
-
340
- <td class="name"><code>props.debug</code></td>
341
-
342
-
343
- <td class="type">
344
-
345
-
346
- <span class="param-type">boolean</span>
347
-
348
-
349
-
350
- </td>
351
-
352
-
353
-
354
-
355
-
356
- <td class="description last"><p>false</p></td>
357
- </tr>
358
-
359
-
360
-
361
- <tr>
362
-
363
- <td class="name"><code>props.tmpl</code></td>
364
-
365
-
366
- <td class="type">
367
-
368
-
369
- <span class="param-type">tmpl</span>
370
-
371
-
372
-
373
- </td>
374
-
375
-
376
-
377
-
378
-
379
- <td class="description last"><p>undefined, // html template</p></td>
380
- </tr>
381
-
382
-
383
- </tbody>
384
- </table>
385
-
386
-
387
-
388
-
389
- <dl class="details">
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
- <dt class="tag-source">Source:</dt>
417
- <dd class="tag-source"><ul class="dummy"><li>
418
- <a href="view-stream.js.html">view-stream.js</a>, <a href="view-stream.js.html#line15">line 15</a>
419
- </li></ul></dd>
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
- </dl>
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
-
443
-
444
-
445
- <h5>Examples</h5>
446
-
447
- <pre class="prettyprint"><code>// returns &lt;h2>Hello World&lt;/h2>
448
- new ViewStream({tagName:'h2', data:'Hello World'};</code></pre>
449
-
450
- <pre class="prettyprint"><code>// returns
451
- &lt;ul>
452
- &lt;li>firstName: Jane&lt;li>
453
- &lt;li>lastName: Doe&lt;li>
454
- &lt;li>Age: 23&lt;li>
455
- &lt;/ul>
456
-
457
- let myTemplate = '&lt;li>firstName: {{fName}}&lt;li>lastName: {{lName}}&lt;li>Age: {{age}}';
458
- let myData = {fName: Jane, lName: Doe, age:23};
459
- new ViewStream({tagName:'ul', data:myData, tmpl:myTemplate});</code></pre>
460
-
461
-
462
-
463
-
464
- </div>
465
-
466
-
467
-
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
-
478
-
479
-
480
-
481
- <h3 class="subsection-title">Methods</h3>
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
- <h4 class="name" id="addChannel"><span class="type-signature"></span>addChannel<span class="signature">(str, bool, bool)</span><span class="type-signature"></span></h4>
490
-
491
-
492
-
493
-
494
-
495
-
496
- <div class="description">
497
- <p>Preferred method to connect to instances of registered channels, such as 'DOM', 'UI', and 'ROUTE' channels.</p>
498
- <p>Add Channel will automatically unsubscribe to the channel, whereas the getChannel method requires the developer to manually unsubscribe.</p>
499
- </div>
500
-
501
-
502
-
503
-
504
-
505
-
506
-
507
-
508
-
509
- <h5>Parameters:</h5>
510
-
511
-
512
- <table class="params">
513
- <thead>
514
- <tr>
515
-
516
- <th>Name</th>
517
-
518
-
519
- <th>Type</th>
520
-
521
-
522
-
523
-
524
- <th>Default</th>
525
-
526
-
527
- <th class="last">Description</th>
528
- </tr>
529
- </thead>
530
-
531
- <tbody>
532
-
533
-
534
- <tr>
535
-
536
- <td class="name"><code>str</code></td>
537
-
538
-
539
- <td class="type">
540
-
541
-
542
- <span class="param-type">string</span>
543
-
544
-
545
-
546
- </td>
547
-
548
-
549
-
550
-
551
- <td class="default">
552
-
553
- </td>
554
-
555
-
556
- <td class="description last"><p>The name of the registered Channel that was added to the Channels Controller.</p></td>
557
- </tr>
558
-
559
-
560
-
561
- <tr>
562
-
563
- <td class="name"><code>bool</code></td>
564
-
565
-
566
- <td class="type">
567
-
568
-
569
- <span class="param-type">boolean</span>
570
-
571
-
572
-
573
- </td>
574
-
575
-
576
-
577
-
578
- <td class="default">
579
-
580
- false
581
-
582
- </td>
583
-
584
-
585
- <td class="description last"><p>false, add true if the View should wait for this channel to unsubscribe before removing itself.</p></td>
586
- </tr>
587
-
588
-
589
-
590
- <tr>
591
-
592
- <td class="name"><code>bool</code></td>
593
-
594
-
595
- <td class="type">
596
-
597
-
598
- <span class="param-type">sendDownStream</span>
599
-
600
-
601
-
602
- </td>
603
-
604
-
605
-
606
-
607
- <td class="default">
608
-
609
- </td>
610
-
611
-
612
- <td class="description last"><p>The direction where the stream is allowed to travel.</p></td>
613
- </tr>
614
-
615
-
616
- </tbody>
617
- </table>
618
-
619
-
620
-
621
-
622
-
623
-
624
- <dl class="details">
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
-
635
-
636
-
637
-
638
-
639
-
640
-
641
-
642
-
643
-
644
-
645
-
646
-
647
-
648
-
649
-
650
-
651
- <dt class="tag-source">Source:</dt>
652
- <dd class="tag-source"><ul class="dummy"><li>
653
- <a href="view-stream.js.html">view-stream.js</a>, <a href="view-stream.js.html#line643">line 643</a>
654
- </li></ul></dd>
655
-
656
-
657
-
658
-
659
-
660
-
661
-
662
- </dl>
663
-
664
-
665
-
666
-
667
-
668
-
669
-
670
-
671
-
672
-
673
-
674
-
675
-
676
-
677
-
678
-
679
-
680
- <h5>Example</h5>
681
-
682
- <pre class="prettyprint"><code>let routeChannel = this.addChannel('ROUTE');
683
-
684
- extendedStateMethods() {
685
- return [
686
- ['CHANNEL_ROUTE_CHANGE_EVENT', 'onMapRouteEvent']
687
- ]
688
- }
689
-
690
- onMapRouteEvent(p) {
691
- console.log('the route value is ', p);
692
- }</code></pre>
693
-
694
-
695
-
696
-
697
-
698
-
699
-
700
-
701
-
702
- <h4 class="name" id="afterRender"><span class="type-signature"></span>afterRender<span class="signature">()</span><span class="type-signature"></span></h4>
703
-
704
-
705
-
706
-
707
-
708
-
709
- <div class="description">
710
- <p>This method is called once the ViewStream's domElement has been rendered and attached to the dom.
711
- <br>
712
- This method is empty and is meant to be overridden.</p>
713
- </div>
714
-
715
-
716
-
717
-
718
-
719
-
720
-
721
-
722
-
723
-
724
-
725
-
726
-
727
- <dl class="details">
728
-
729
-
730
-
731
-
732
-
733
-
734
-
735
-
736
-
737
-
738
-
739
-
740
-
741
-
742
-
743
-
744
-
745
-
746
-
747
-
748
-
749
-
750
-
751
-
752
-
753
-
754
- <dt class="tag-source">Source:</dt>
755
- <dd class="tag-source"><ul class="dummy"><li>
756
- <a href="view-stream.js.html">view-stream.js</a>, <a href="view-stream.js.html#line565">line 565</a>
757
- </li></ul></dd>
758
-
759
-
760
-
761
-
762
-
763
-
764
-
765
- </dl>
766
-
767
-
768
-
769
-
770
-
771
-
772
-
773
-
774
-
775
-
776
-
777
-
778
-
779
-
780
-
781
-
782
-
783
-
784
-
785
-
786
-
787
-
788
-
789
-
790
- <h4 class="name" id="appendToDom"><span class="type-signature"></span>appendToDom<span class="signature">(node)</span><span class="type-signature"></span></h4>
791
-
792
-
793
-
794
-
795
-
796
-
797
- <div class="description">
798
- <p>Appends a ViewStream object to an existing dom element.</p>
799
- </div>
800
-
801
-
802
-
803
-
804
-
805
-
806
-
807
-
808
-
809
- <h5>Parameters:</h5>
810
-
811
-
812
- <table class="params">
813
- <thead>
814
- <tr>
815
-
816
- <th>Name</th>
817
-
818
-
819
- <th>Type</th>
820
-
821
-
822
-
823
-
824
-
825
- <th class="last">Description</th>
826
- </tr>
827
- </thead>
828
-
829
- <tbody>
830
-
831
-
832
- <tr>
833
-
834
- <td class="name"><code>node</code></td>
835
-
836
-
837
- <td class="type">
838
-
839
-
840
- <span class="param-type">dom</span>
841
-
842
-
843
-
844
- </td>
845
-
846
-
847
-
848
-
849
-
850
- <td class="description last"><p>the ViewStream child that is to be attached.</p></td>
851
- </tr>
852
-
853
-
854
- </tbody>
855
- </table>
856
-
857
-
858
-
859
-
860
-
861
-
862
- <dl class="details">
863
-
864
-
865
-
866
-
867
-
868
-
869
-
870
-
871
-
872
-
873
-
874
-
875
-
876
-
877
-
878
-
879
-
880
-
881
-
882
-
883
-
884
-
885
-
886
-
887
-
888
-
889
- <dt class="tag-source">Source:</dt>
890
- <dd class="tag-source"><ul class="dummy"><li>
891
- <a href="view-stream.js.html">view-stream.js</a>, <a href="view-stream.js.html#line434">line 434</a>
892
- </li></ul></dd>
893
-
894
-
895
-
896
-
897
-
898
-
899
-
900
- </dl>
901
-
902
-
903
-
904
-
905
-
906
-
907
-
908
-
909
-
910
-
911
-
912
-
913
-
914
-
915
-
916
-
917
-
918
- <h5>Example</h5>
919
-
920
- <pre class="prettyprint"><code>// returns
921
- &lt;body>
922
- &lt;h2>Hello World&lt;/h2>
923
- &lt;/body>
924
-
925
- let viewStream = new ViewStream('h2', 'Hello World');
926
- viewStream.appendToDom(document.body);</code></pre>
927
-
928
-
929
-
930
-
931
-
932
-
933
-
934
-
935
-
936
- <h4 class="name" id="appendView"><span class="type-signature"></span>appendView<span class="signature">(v, query)</span><span class="type-signature"></span></h4>
937
-
938
-
939
-
940
-
941
-
942
-
943
- <div class="description">
944
- <p>This method appends a child ViewStream object. <br>After the attachment, rxjs observables are exchanged between the parent and child ViewStream objects.<br><br></p>
945
- </div>
946
-
947
-
948
-
949
-
950
-
951
-
952
-
953
-
954
-
955
- <h5>Parameters:</h5>
956
-
957
-
958
- <table class="params">
959
- <thead>
960
- <tr>
961
-
962
- <th>Name</th>
963
-
964
-
965
- <th>Type</th>
966
-
967
-
968
-
969
-
970
-
971
- <th class="last">Description</th>
972
- </tr>
973
- </thead>
974
-
975
- <tbody>
976
-
977
-
978
- <tr>
979
-
980
- <td class="name"><code>v</code></td>
981
-
982
-
983
- <td class="type">
984
-
985
-
986
- <span class="param-type"><a href="ViewStream.html">ViewStream</a></span>
987
-
988
-
989
-
990
- </td>
991
-
992
-
993
-
994
-
995
-
996
- <td class="description last"><p>the ViewStream child that is to be attached.</p></td>
997
- </tr>
998
-
999
-
1000
-
1001
- <tr>
1002
-
1003
- <td class="name"><code>query</code></td>
1004
-
1005
-
1006
- <td class="type">
1007
-
1008
-
1009
- <span class="param-type">string</span>
1010
-
1011
-
1012
-
1013
- </td>
1014
-
1015
-
1016
-
1017
-
1018
-
1019
- <td class="description last"><p>a querySelector within this ViewStream.</p></td>
1020
- </tr>
1021
-
1022
-
1023
- </tbody>
1024
- </table>
1025
-
1026
-
1027
-
1028
-
1029
-
1030
-
1031
- <dl class="details">
1032
-
1033
-
1034
-
1035
-
1036
-
1037
-
1038
-
1039
-
1040
-
1041
-
1042
-
1043
-
1044
-
1045
-
1046
-
1047
-
1048
-
1049
-
1050
-
1051
-
1052
-
1053
-
1054
-
1055
-
1056
-
1057
-
1058
- <dt class="tag-source">Source:</dt>
1059
- <dd class="tag-source"><ul class="dummy"><li>
1060
- <a href="view-stream.js.html">view-stream.js</a>, <a href="view-stream.js.html#line471">line 471</a>
1061
- </li></ul></dd>
1062
-
1063
-
1064
-
1065
-
1066
-
1067
-
1068
-
1069
- </dl>
1070
-
1071
-
1072
-
1073
-
1074
-
1075
-
1076
-
1077
-
1078
-
1079
-
1080
-
1081
-
1082
-
1083
-
1084
-
1085
-
1086
-
1087
- <h5>Example</h5>
1088
-
1089
- <pre class="prettyprint"><code>// returns
1090
- &lt;body>
1091
- &lt;main>
1092
- &lt;h2>Hello World&lt;/h2>
1093
- &lt;/main>
1094
- &lt;/body>
1095
-
1096
-
1097
- let parentView = new ViewStream('main');
1098
- parentView.appendToDom(document.body);
1099
-
1100
- let childView = new ViewStream({tagName:'h2', data:'Hello World'};
1101
- parentView.appendView(childView)</code></pre>
1102
-
1103
-
1104
-
1105
-
1106
-
1107
-
1108
-
1109
-
1110
-
1111
- <h4 class="name" id="appendViewToParent"><span class="type-signature"></span>appendViewToParent<span class="signature">(v, query, this)</span><span class="type-signature"></span></h4>
1112
-
1113
-
1114
-
1115
-
1116
-
1117
-
1118
- <div class="description">
1119
- <p>This method appends a child ViewStream object to a parent ViewStream object.</p>
1120
- </div>
1121
-
1122
-
1123
-
1124
-
1125
-
1126
-
1127
-
1128
-
1129
-
1130
- <h5>Parameters:</h5>
1131
-
1132
-
1133
- <table class="params">
1134
- <thead>
1135
- <tr>
1136
-
1137
- <th>Name</th>
1138
-
1139
-
1140
- <th>Type</th>
1141
-
1142
-
1143
-
1144
-
1145
-
1146
- <th class="last">Description</th>
1147
- </tr>
1148
- </thead>
1149
-
1150
- <tbody>
1151
-
1152
-
1153
- <tr>
1154
-
1155
- <td class="name"><code>v</code></td>
1156
-
1157
-
1158
- <td class="type">
1159
-
1160
-
1161
- <span class="param-type"><a href="ViewStream.html">ViewStream</a></span>
1162
-
1163
-
1164
-
1165
- </td>
1166
-
1167
-
1168
-
1169
-
1170
-
1171
- <td class="description last"><p>the ViewStream parent.</p></td>
1172
- </tr>
1173
-
1174
-
1175
-
1176
- <tr>
1177
-
1178
- <td class="name"><code>query</code></td>
1179
-
1180
-
1181
- <td class="type">
1182
-
1183
-
1184
- <span class="param-type">string</span>
1185
-
1186
-
1187
-
1188
- </td>
1189
-
1190
-
1191
-
1192
-
1193
-
1194
- <td class="description last"><p>a querySelector within this ViewStream.</p></td>
1195
- </tr>
1196
-
1197
-
1198
-
1199
- <tr>
1200
-
1201
- <td class="name"><code>this</code></td>
1202
-
1203
-
1204
- <td class="type">
1205
-
1206
-
1207
- <span class="param-type">level</span>
1208
-
1209
-
1210
-
1211
- </td>
1212
-
1213
-
1214
-
1215
-
1216
-
1217
- <td class="description last"><p>parameters can attach the viewStream's dom element up the dom tree while still maintaining the parent-child relationship of the ViewStream objects.</p></td>
1218
- </tr>
1219
-
1220
-
1221
- </tbody>
1222
- </table>
1223
-
1224
-
1225
-
1226
-
1227
-
1228
-
1229
- <dl class="details">
1230
-
1231
-
1232
-
1233
-
1234
-
1235
-
1236
-
1237
-
1238
-
1239
-
1240
-
1241
-
1242
-
1243
-
1244
-
1245
-
1246
-
1247
-
1248
-
1249
-
1250
-
1251
-
1252
-
1253
-
1254
-
1255
-
1256
- <dt class="tag-source">Source:</dt>
1257
- <dd class="tag-source"><ul class="dummy"><li>
1258
- <a href="view-stream.js.html">view-stream.js</a>, <a href="view-stream.js.html#line498">line 498</a>
1259
- </li></ul></dd>
1260
-
1261
-
1262
-
1263
-
1264
-
1265
-
1266
-
1267
- </dl>
1268
-
1269
-
1270
-
1271
-
1272
-
1273
-
1274
-
1275
-
1276
-
1277
-
1278
-
1279
-
1280
-
1281
-
1282
-
1283
-
1284
-
1285
- <h5>Example</h5>
1286
-
1287
- <pre class="prettyprint"><code>// returns
1288
- &lt;body>
1289
- &lt;main>
1290
- &lt;h2>Hello World&lt;/h2>
1291
- &lt;/main>
1292
- &lt;/body>
1293
-
1294
-
1295
- let parentView = new ViewStream('main');
1296
- parentView.appendToDom(document.body);
1297
-
1298
- let childView = new ViewStream({tagName:'h2', data:'Hello World'};
1299
- childView.appendToParent(parentView)</code></pre>
1300
-
1301
-
1302
-
1303
-
1304
-
1305
-
1306
-
1307
-
1308
-
1309
- <h4 class="name" id="broadcastEvents"><span class="type-signature"></span>broadcastEvents<span class="signature">()</span><span class="type-signature"></span></h4>
1310
-
1311
-
1312
-
1313
-
1314
-
1315
-
1316
- <div class="description">
1317
- <p>Add any query within the ViewStream's dom and any dom events to automatically be observed by the UI Channel.
1318
- <br></p>
1319
- </div>
1320
-
1321
-
1322
-
1323
-
1324
-
1325
-
1326
-
1327
-
1328
-
1329
-
1330
-
1331
-
1332
-
1333
- <dl class="details">
1334
-
1335
-
1336
-
1337
-
1338
-
1339
-
1340
-
1341
-
1342
-
1343
-
1344
-
1345
-
1346
-
1347
-
1348
-
1349
-
1350
-
1351
-
1352
-
1353
-
1354
-
1355
-
1356
-
1357
-
1358
-
1359
-
1360
- <dt class="tag-source">Source:</dt>
1361
- <dd class="tag-source"><ul class="dummy"><li>
1362
- <a href="view-stream.js.html">view-stream.js</a>, <a href="view-stream.js.html#line585">line 585</a>
1363
- </li></ul></dd>
1364
-
1365
-
1366
-
1367
-
1368
-
1369
-
1370
-
1371
- </dl>
1372
-
1373
-
1374
-
1375
-
1376
-
1377
-
1378
-
1379
-
1380
-
1381
-
1382
-
1383
-
1384
-
1385
-
1386
-
1387
-
1388
-
1389
- <h5>Example</h5>
1390
-
1391
- <pre class="prettyprint"><code>broadcastEvents() {
1392
- // ADD BUTTON EVENTS AS NESTED ARRAYS
1393
- return [
1394
- ['#my-button', 'mouseover'],
1395
- ['#my-input', 'change']
1396
- ]
1397
- }</code></pre>
1398
-
1399
-
1400
-
1401
-
1402
-
1403
-
1404
-
1405
-
1406
-
1407
- <h4 class="name" id="getChannel"><span class="type-signature"></span>getChannel<span class="signature">()</span><span class="type-signature"></span></h4>
1408
-
1409
-
1410
-
1411
-
1412
-
1413
-
1414
- <div class="description">
1415
- <p>Automatically connect to an instance of registered channels, such as 'DOM', 'UI', and 'ROUTE' channels.</p>
1416
- </div>
1417
-
1418
-
1419
-
1420
-
1421
-
1422
-
1423
-
1424
-
1425
-
1426
-
1427
-
1428
-
1429
-
1430
- <dl class="details">
1431
-
1432
-
1433
-
1434
-
1435
-
1436
-
1437
-
1438
-
1439
-
1440
-
1441
-
1442
-
1443
-
1444
-
1445
-
1446
-
1447
-
1448
-
1449
-
1450
-
1451
-
1452
-
1453
-
1454
-
1455
-
1456
-
1457
- <dt class="tag-source">Source:</dt>
1458
- <dd class="tag-source"><ul class="dummy"><li>
1459
- <a href="view-stream.js.html">view-stream.js</a>, <a href="view-stream.js.html#line606">line 606</a>
1460
- </li></ul></dd>
1461
-
1462
-
1463
-
1464
-
1465
-
1466
-
1467
-
1468
- </dl>
1469
-
1470
-
1471
-
1472
-
1473
-
1474
-
1475
-
1476
-
1477
-
1478
-
1479
-
1480
-
1481
-
1482
-
1483
-
1484
-
1485
-
1486
- <h5>Example</h5>
1487
-
1488
- <pre class="prettyprint"><code>let uiChannel = this.getChannel('UI');
1489
-
1490
- uiChannel
1491
- .filter((p) => p.data.id==='#my-button')
1492
- .subscribe((p) => console.log('my button was clicked ', p));</code></pre>
1493
-
1494
-
1495
-
1496
-
1497
-
1498
-
1499
-
1500
-
1501
-
1502
- <h4 class="name" id="prependToDom"><span class="type-signature"></span>prependToDom<span class="signature">(node)</span><span class="type-signature"></span></h4>
1503
-
1504
-
1505
-
1506
-
1507
-
1508
-
1509
- <div class="description">
1510
- <p>Prepends the current ViewStream object to an existing dom element.</p>
1511
- </div>
1512
-
1513
-
1514
-
1515
-
1516
-
1517
-
1518
-
1519
-
1520
-
1521
- <h5>Parameters:</h5>
1522
-
1523
-
1524
- <table class="params">
1525
- <thead>
1526
- <tr>
1527
-
1528
- <th>Name</th>
1529
-
1530
-
1531
- <th>Type</th>
1532
-
1533
-
1534
-
1535
-
1536
-
1537
- <th class="last">Description</th>
1538
- </tr>
1539
- </thead>
1540
-
1541
- <tbody>
1542
-
1543
-
1544
- <tr>
1545
-
1546
- <td class="name"><code>node</code></td>
1547
-
1548
-
1549
- <td class="type">
1550
-
1551
-
1552
- <span class="param-type">dom</span>
1553
-
1554
-
1555
-
1556
- </td>
1557
-
1558
-
1559
-
1560
-
1561
-
1562
- <td class="description last"><p>the ViewStream child that is to be attached.</p></td>
1563
- </tr>
1564
-
1565
-
1566
- </tbody>
1567
- </table>
1568
-
1569
-
1570
-
1571
-
1572
-
1573
-
1574
- <dl class="details">
1575
-
1576
-
1577
-
1578
-
1579
-
1580
-
1581
-
1582
-
1583
-
1584
-
1585
-
1586
-
1587
-
1588
-
1589
-
1590
-
1591
-
1592
-
1593
-
1594
-
1595
-
1596
-
1597
-
1598
-
1599
-
1600
-
1601
- <dt class="tag-source">Source:</dt>
1602
- <dd class="tag-source"><ul class="dummy"><li>
1603
- <a href="view-stream.js.html">view-stream.js</a>, <a href="view-stream.js.html#line447">line 447</a>
1604
- </li></ul></dd>
1605
-
1606
-
1607
-
1608
-
1609
-
1610
-
1611
-
1612
- </dl>
1613
-
1614
-
1615
-
1616
-
1617
-
1618
-
1619
-
1620
-
1621
-
1622
-
1623
-
1624
-
1625
-
1626
-
1627
-
1628
-
1629
-
1630
- <h5>Example</h5>
1631
-
1632
- <pre class="prettyprint"><code>this.prependToDom(document.body);</code></pre>
1633
-
1634
-
1635
-
1636
-
1637
-
1638
-
1639
-
1640
-
1641
-
1642
- <h4 class="name" id="prependView"><span class="type-signature"></span>prependView<span class="signature">(v, query)</span><span class="type-signature"></span></h4>
1643
-
1644
-
1645
-
1646
-
1647
-
1648
-
1649
- <div class="description">
1650
- <p>This method prepends a child ViewStream object to the current ViewStream object. <br>After the attachment, rxjs observables are exchanged between the parent and child ViewStream objects.<br><br></p>
1651
- </div>
1652
-
1653
-
1654
-
1655
-
1656
-
1657
-
1658
-
1659
-
1660
-
1661
- <h5>Parameters:</h5>
1662
-
1663
-
1664
- <table class="params">
1665
- <thead>
1666
- <tr>
1667
-
1668
- <th>Name</th>
1669
-
1670
-
1671
- <th>Type</th>
1672
-
1673
-
1674
-
1675
-
1676
-
1677
- <th class="last">Description</th>
1678
- </tr>
1679
- </thead>
1680
-
1681
- <tbody>
1682
-
1683
-
1684
- <tr>
1685
-
1686
- <td class="name"><code>v</code></td>
1687
-
1688
-
1689
- <td class="type">
1690
-
1691
-
1692
- <span class="param-type"><a href="ViewStream.html">ViewStream</a></span>
1693
-
1694
-
1695
-
1696
- </td>
1697
-
1698
-
1699
-
1700
-
1701
-
1702
- <td class="description last"><p>the ViewStream child that is to be attached.</p></td>
1703
- </tr>
1704
-
1705
-
1706
-
1707
- <tr>
1708
-
1709
- <td class="name"><code>query</code></td>
1710
-
1711
-
1712
- <td class="type">
1713
-
1714
-
1715
- <span class="param-type">string</span>
1716
-
1717
-
1718
-
1719
- </td>
1720
-
1721
-
1722
-
1723
-
1724
-
1725
- <td class="description last"><p>a querySelector within this ViewStream.</p></td>
1726
- </tr>
1727
-
1728
-
1729
- </tbody>
1730
- </table>
1731
-
1732
-
1733
-
1734
-
1735
-
1736
-
1737
- <dl class="details">
1738
-
1739
-
1740
-
1741
-
1742
-
1743
-
1744
-
1745
-
1746
-
1747
-
1748
-
1749
-
1750
-
1751
-
1752
-
1753
-
1754
-
1755
-
1756
-
1757
-
1758
-
1759
-
1760
-
1761
-
1762
-
1763
-
1764
- <dt class="tag-source">Source:</dt>
1765
- <dd class="tag-source"><ul class="dummy"><li>
1766
- <a href="view-stream.js.html">view-stream.js</a>, <a href="view-stream.js.html#line543">line 543</a>
1767
- </li></ul></dd>
1768
-
1769
-
1770
-
1771
-
1772
-
1773
-
1774
-
1775
- </dl>
1776
-
1777
-
1778
-
1779
-
1780
-
1781
-
1782
-
1783
-
1784
-
1785
-
1786
-
1787
-
1788
-
1789
-
1790
-
1791
-
1792
-
1793
- <h5>Example</h5>
1794
-
1795
- <pre class="prettyprint"><code>// returns
1796
- &lt;body>
1797
- &lt;main>
1798
- &lt;h2>Hello World&lt;/h2>
1799
- &lt;/main>
1800
- &lt;/body>
1801
-
1802
- let parentView = new ViewStream('main');
1803
- parentView.appendToDom(document.body);
1804
-
1805
- let childView = new ViewStream({tagName:'h2', data:'Hello World'};
1806
- parentView.prependView(childView);</code></pre>
1807
-
1808
-
1809
-
1810
-
1811
-
1812
-
1813
-
1814
-
1815
-
1816
- <h4 class="name" id="prependViewToParent"><span class="type-signature"></span>prependViewToParent<span class="signature">(v, query, level)</span><span class="type-signature"></span></h4>
1817
-
1818
-
1819
-
1820
-
1821
-
1822
-
1823
- <div class="description">
1824
- <p>This method prepends a child ViewStream object to a parent ViewStream object.</p>
1825
- </div>
1826
-
1827
-
1828
-
1829
-
1830
-
1831
-
1832
-
1833
-
1834
-
1835
- <h5>Parameters:</h5>
1836
-
1837
-
1838
- <table class="params">
1839
- <thead>
1840
- <tr>
1841
-
1842
- <th>Name</th>
1843
-
1844
-
1845
- <th>Type</th>
1846
-
1847
-
1848
-
1849
-
1850
- <th>Default</th>
1851
-
1852
-
1853
- <th class="last">Description</th>
1854
- </tr>
1855
- </thead>
1856
-
1857
- <tbody>
1858
-
1859
-
1860
- <tr>
1861
-
1862
- <td class="name"><code>v</code></td>
1863
-
1864
-
1865
- <td class="type">
1866
-
1867
-
1868
- <span class="param-type"><a href="ViewStream.html">ViewStream</a></span>
1869
-
1870
-
1871
-
1872
- </td>
1873
-
1874
-
1875
-
1876
-
1877
- <td class="default">
1878
-
1879
- </td>
1880
-
1881
-
1882
- <td class="description last"><p>the ViewStream parent.</p></td>
1883
- </tr>
1884
-
1885
-
1886
-
1887
- <tr>
1888
-
1889
- <td class="name"><code>query</code></td>
1890
-
1891
-
1892
- <td class="type">
1893
-
1894
-
1895
- <span class="param-type">string</span>
1896
-
1897
-
1898
-
1899
- </td>
1900
-
1901
-
1902
-
1903
-
1904
- <td class="default">
1905
-
1906
- </td>
1907
-
1908
-
1909
- <td class="description last"><p>a querySelector within this ViewStream.</p></td>
1910
- </tr>
1911
-
1912
-
1913
-
1914
- <tr>
1915
-
1916
- <td class="name"><code>level</code></td>
1917
-
1918
-
1919
- <td class="type">
1920
-
1921
-
1922
- <span class="param-type">number</span>
1923
-
1924
-
1925
-
1926
- </td>
1927
-
1928
-
1929
-
1930
-
1931
- <td class="default">
1932
-
1933
- 1
1934
-
1935
- </td>
1936
-
1937
-
1938
- <td class="description last"><p>this parameter can attach the viewStream's dom element up the dom tree while still maintaining the parent-child relationship of the ViewStream objects.</p></td>
1939
- </tr>
1940
-
1941
-
1942
- </tbody>
1943
- </table>
1944
-
1945
-
1946
-
1947
-
1948
-
1949
-
1950
- <dl class="details">
1951
-
1952
-
1953
-
1954
-
1955
-
1956
-
1957
-
1958
-
1959
-
1960
-
1961
-
1962
-
1963
-
1964
-
1965
-
1966
-
1967
-
1968
-
1969
-
1970
-
1971
-
1972
-
1973
-
1974
-
1975
-
1976
-
1977
- <dt class="tag-source">Source:</dt>
1978
- <dd class="tag-source"><ul class="dummy"><li>
1979
- <a href="view-stream.js.html">view-stream.js</a>, <a href="view-stream.js.html#line516">line 516</a>
1980
- </li></ul></dd>
1981
-
1982
-
1983
-
1984
-
1985
-
1986
-
1987
-
1988
- </dl>
1989
-
1990
-
1991
-
1992
-
1993
-
1994
-
1995
-
1996
-
1997
-
1998
-
1999
-
2000
-
2001
-
2002
-
2003
-
2004
-
2005
-
2006
- <h5>Example</h5>
2007
-
2008
- <pre class="prettyprint"><code>let parentView = new ViewStream('main');
2009
- parentView.prependToDom(document.body);
2010
-
2011
- let childView = new ViewStream({tagName:'h2', data:'Hello World'};
2012
- childView.prependViewToParent(parentView)</code></pre>
2013
-
2014
-
2015
-
2016
-
2017
-
2018
-
2019
-
2020
-
2021
-
2022
- <h4 class="name" id="sendChannelPayload"><span class="type-signature"></span>sendChannelPayload<span class="signature">(channelName, action, payload)</span><span class="type-signature"></span></h4>
2023
-
2024
-
2025
-
2026
-
2027
-
2028
-
2029
- <div class="description">
2030
- <p>Method to send data to any registered channel.
2031
- *</p>
2032
- </div>
2033
-
2034
-
2035
-
2036
-
2037
-
2038
-
2039
-
2040
-
2041
-
2042
- <h5>Parameters:</h5>
2043
-
2044
-
2045
- <table class="params">
2046
- <thead>
2047
- <tr>
2048
-
2049
- <th>Name</th>
2050
-
2051
-
2052
- <th>Type</th>
2053
-
2054
-
2055
-
2056
-
2057
- <th>Default</th>
2058
-
2059
-
2060
- <th class="last">Description</th>
2061
- </tr>
2062
- </thead>
2063
-
2064
- <tbody>
2065
-
2066
-
2067
- <tr>
2068
-
2069
- <td class="name"><code>channelName</code></td>
2070
-
2071
-
2072
- <td class="type">
2073
-
2074
-
2075
- <span class="param-type">string</span>
2076
-
2077
-
2078
-
2079
- </td>
2080
-
2081
-
2082
-
2083
-
2084
- <td class="default">
2085
-
2086
- </td>
2087
-
2088
-
2089
- <td class="description last"><p>The name of the registered Channel that was added to the Channels Controller.</p></td>
2090
- </tr>
2091
-
2092
-
2093
-
2094
- <tr>
2095
-
2096
- <td class="name"><code>action</code></td>
2097
-
2098
-
2099
- <td class="type">
2100
-
2101
-
2102
- <span class="param-type">string</span>
2103
-
2104
-
2105
-
2106
- </td>
2107
-
2108
-
2109
-
2110
-
2111
- <td class="default">
2112
-
2113
- DEFAULT_EVENT
2114
-
2115
- </td>
2116
-
2117
-
2118
- <td class="description last"><p>The event type that listeners can point to.</p></td>
2119
- </tr>
2120
-
2121
-
2122
-
2123
- <tr>
2124
-
2125
- <td class="name"><code>payload</code></td>
2126
-
2127
-
2128
- <td class="type">
2129
-
2130
-
2131
- <span class="param-type">object</span>
2132
-
2133
-
2134
-
2135
- </td>
2136
-
2137
-
2138
-
2139
-
2140
- <td class="default">
2141
-
2142
- </td>
2143
-
2144
-
2145
- <td class="description last"><p>{}, The main data to send to the channel.</p></td>
2146
- </tr>
2147
-
2148
-
2149
- </tbody>
2150
- </table>
2151
-
2152
-
2153
-
2154
-
2155
-
2156
-
2157
- <dl class="details">
2158
-
2159
-
2160
-
2161
-
2162
-
2163
-
2164
-
2165
-
2166
-
2167
-
2168
-
2169
-
2170
-
2171
-
2172
-
2173
-
2174
-
2175
-
2176
-
2177
-
2178
-
2179
-
2180
-
2181
-
2182
-
2183
-
2184
- <dt class="tag-source">Source:</dt>
2185
- <dd class="tag-source"><ul class="dummy"><li>
2186
- <a href="view-stream.js.html">view-stream.js</a>, <a href="view-stream.js.html#line680">line 680</a>
2187
- </li></ul></dd>
2188
-
2189
-
2190
-
2191
-
2192
-
2193
-
2194
-
2195
- </dl>
2196
-
2197
-
2198
-
2199
-
2200
-
2201
-
2202
-
2203
-
2204
-
2205
-
2206
-
2207
-
2208
-
2209
-
2210
-
2211
-
2212
-
2213
- <h5>Example</h5>
2214
-
2215
- <pre class="prettyprint"><code>let payload = {'location' : 'about'};
2216
- let action = 'PAGE_CHANGE_EVENT';
2217
- this.sendChannelPayload('ROUTE', paylaod, action);</code></pre>
2218
-
2219
-
2220
-
2221
-
2222
-
2223
-
2224
-
2225
-
2226
-
2227
- </article>
2228
-
2229
- </section>
2230
-
2231
-
2232
-
2233
-
2234
- </div>
2235
-
2236
- <nav>
2237
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="DomItem.html">DomItem</a></li><li><a href="ViewStream.html">ViewStream</a></li></ul>
2238
- </nav>
2239
-
2240
- <br class="clear">
2241
-
2242
- <footer>
2243
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Dec 15 2017 22:34:55 GMT-0500 (EST)
2244
- </footer>
2245
-
2246
- <script> prettyPrint(); </script>
2247
- <script src="scripts/linenumber.js"> </script>
2248
- </body>
2249
- </html>