Skip to content

Commit 0800efd

Browse files
kum-deepakkum-deepak
committed
Committed by Github action
master: { "stompjs": "6.1.2", "rx-stomp": "1.1.4" } develop: { "stompjs": "7.0.0-beta2", "rx-stomp": "2.0.0-beta1" }
1 parent de9dac9 commit 0800efd

File tree

11 files changed

+237
-230
lines changed

11 files changed

+237
-230
lines changed

‎api-docs/develop/classes/Client.html

Lines changed: 124 additions & 116 deletions
Large diffs are not rendered by default.

‎api-docs/develop/classes/CompatClient.html

Lines changed: 63 additions & 59 deletions
Large diffs are not rendered by default.

‎api-docs/develop/classes/StompConfig.html

Lines changed: 28 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,6 @@ <h3>Description</h3>
7474
<p>Configuration options for STOMP Client, each key corresponds to
7575
field by the same name in <a href="../classes/Client.html">Client</a>. This can be passed to
7676
the constructor of <a href="../classes/Client.html">Client</a> or to <a href="../classes/Client.html#configure">Client#configure</a>.</p>
77-
<p>There used to be a class with the same name in <code>@stomp/ng2-stompjs</code>, which has been replaced by
78-
<a href="../classes/RxStompConfig.html">RxStompConfig</a> and <a href="InjectableRxStompConfig">InjectableRxStompConfig</a>.</p>
7977
<p>Part of <code>@stomp/stompjs</code>.</p>
8078

8179
</p>
@@ -265,7 +263,7 @@ <h3 id="inputs">
265263
</tr>
266264
<tr>
267265
<td class="col-md-4">
268-
<div class="io-line">Defined in <a href="" data-line="71" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:71</a></div>
266+
<div class="io-line">Defined in <a href="" data-line="68" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:68</a></div>
269267
</td>
270268
</tr>
271269

@@ -299,7 +297,7 @@ <h3 id="inputs">
299297
</tr>
300298
<tr>
301299
<td class="col-md-4">
302-
<div class="io-line">Defined in <a href="" data-line="106" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:106</a></div>
300+
<div class="io-line">Defined in <a href="" data-line="103" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:103</a></div>
303301
</td>
304302
</tr>
305303

@@ -333,7 +331,7 @@ <h3 id="inputs">
333331
</tr>
334332
<tr>
335333
<td class="col-md-4">
336-
<div class="io-line">Defined in <a href="" data-line="26" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:26</a></div>
334+
<div class="io-line">Defined in <a href="" data-line="23" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:23</a></div>
337335
</td>
338336
</tr>
339337

@@ -367,7 +365,7 @@ <h3 id="inputs">
367365
</tr>
368366
<tr>
369367
<td class="col-md-4">
370-
<div class="io-line">Defined in <a href="" data-line="81" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:81</a></div>
368+
<div class="io-line">Defined in <a href="" data-line="78" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:78</a></div>
371369
</td>
372370
</tr>
373371

@@ -401,7 +399,7 @@ <h3 id="inputs">
401399
</tr>
402400
<tr>
403401
<td class="col-md-4">
404-
<div class="io-line">Defined in <a href="" data-line="41" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:41</a></div>
402+
<div class="io-line">Defined in <a href="" data-line="38" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:38</a></div>
405403
</td>
406404
</tr>
407405

@@ -435,7 +433,7 @@ <h3 id="inputs">
435433
</tr>
436434
<tr>
437435
<td class="col-md-4">
438-
<div class="io-line">Defined in <a href="" data-line="141" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:141</a></div>
436+
<div class="io-line">Defined in <a href="" data-line="138" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:138</a></div>
439437
</td>
440438
</tr>
441439

@@ -469,7 +467,7 @@ <h3 id="inputs">
469467
</tr>
470468
<tr>
471469
<td class="col-md-4">
472-
<div class="io-line">Defined in <a href="" data-line="146" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:146</a></div>
470+
<div class="io-line">Defined in <a href="" data-line="143" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:143</a></div>
473471
</td>
474472
</tr>
475473

@@ -503,7 +501,7 @@ <h3 id="inputs">
503501
</tr>
504502
<tr>
505503
<td class="col-md-4">
506-
<div class="io-line">Defined in <a href="" data-line="86" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:86</a></div>
504+
<div class="io-line">Defined in <a href="" data-line="83" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:83</a></div>
507505
</td>
508506
</tr>
509507

@@ -537,7 +535,7 @@ <h3 id="inputs">
537535
</tr>
538536
<tr>
539537
<td class="col-md-4">
540-
<div class="io-line">Defined in <a href="" data-line="66" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:66</a></div>
538+
<div class="io-line">Defined in <a href="" data-line="63" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:63</a></div>
541539
</td>
542540
</tr>
543541

@@ -571,7 +569,7 @@ <h3 id="inputs">
571569
</tr>
572570
<tr>
573571
<td class="col-md-4">
574-
<div class="io-line">Defined in <a href="" data-line="51" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:51</a></div>
572+
<div class="io-line">Defined in <a href="" data-line="48" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:48</a></div>
575573
</td>
576574
</tr>
577575

@@ -605,7 +603,7 @@ <h3 id="inputs">
605603
</tr>
606604
<tr>
607605
<td class="col-md-4">
608-
<div class="io-line">Defined in <a href="" data-line="56" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:56</a></div>
606+
<div class="io-line">Defined in <a href="" data-line="53" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:53</a></div>
609607
</td>
610608
</tr>
611609

@@ -639,7 +637,7 @@ <h3 id="inputs">
639637
</tr>
640638
<tr>
641639
<td class="col-md-4">
642-
<div class="io-line">Defined in <a href="" data-line="136" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:136</a></div>
640+
<div class="io-line">Defined in <a href="" data-line="133" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:133</a></div>
643641
</td>
644642
</tr>
645643

@@ -673,7 +671,7 @@ <h3 id="inputs">
673671
</tr>
674672
<tr>
675673
<td class="col-md-4">
676-
<div class="io-line">Defined in <a href="" data-line="76" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:76</a></div>
674+
<div class="io-line">Defined in <a href="" data-line="73" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:73</a></div>
677675
</td>
678676
</tr>
679677

@@ -707,7 +705,7 @@ <h3 id="inputs">
707705
</tr>
708706
<tr>
709707
<td class="col-md-4">
710-
<div class="io-line">Defined in <a href="" data-line="151" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:151</a></div>
708+
<div class="io-line">Defined in <a href="" data-line="148" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:148</a></div>
711709
</td>
712710
</tr>
713711

@@ -741,7 +739,7 @@ <h3 id="inputs">
741739
</tr>
742740
<tr>
743741
<td class="col-md-4">
744-
<div class="io-line">Defined in <a href="" data-line="111" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:111</a></div>
742+
<div class="io-line">Defined in <a href="" data-line="108" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:108</a></div>
745743
</td>
746744
</tr>
747745

@@ -775,7 +773,7 @@ <h3 id="inputs">
775773
</tr>
776774
<tr>
777775
<td class="col-md-4">
778-
<div class="io-line">Defined in <a href="" data-line="116" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:116</a></div>
776+
<div class="io-line">Defined in <a href="" data-line="113" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:113</a></div>
779777
</td>
780778
</tr>
781779

@@ -809,7 +807,7 @@ <h3 id="inputs">
809807
</tr>
810808
<tr>
811809
<td class="col-md-4">
812-
<div class="io-line">Defined in <a href="" data-line="121" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:121</a></div>
810+
<div class="io-line">Defined in <a href="" data-line="118" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:118</a></div>
813811
</td>
814812
</tr>
815813

@@ -843,7 +841,7 @@ <h3 id="inputs">
843841
</tr>
844842
<tr>
845843
<td class="col-md-4">
846-
<div class="io-line">Defined in <a href="" data-line="101" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:101</a></div>
844+
<div class="io-line">Defined in <a href="" data-line="98" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:98</a></div>
847845
</td>
848846
</tr>
849847

@@ -877,7 +875,7 @@ <h3 id="inputs">
877875
</tr>
878876
<tr>
879877
<td class="col-md-4">
880-
<div class="io-line">Defined in <a href="" data-line="91" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:91</a></div>
878+
<div class="io-line">Defined in <a href="" data-line="88" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:88</a></div>
881879
</td>
882880
</tr>
883881

@@ -911,7 +909,7 @@ <h3 id="inputs">
911909
</tr>
912910
<tr>
913911
<td class="col-md-4">
914-
<div class="io-line">Defined in <a href="" data-line="96" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:96</a></div>
912+
<div class="io-line">Defined in <a href="" data-line="93" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:93</a></div>
915913
</td>
916914
</tr>
917915

@@ -945,7 +943,7 @@ <h3 id="inputs">
945943
</tr>
946944
<tr>
947945
<td class="col-md-4">
948-
<div class="io-line">Defined in <a href="" data-line="126" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:126</a></div>
946+
<div class="io-line">Defined in <a href="" data-line="123" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:123</a></div>
949947
</td>
950948
</tr>
951949

@@ -979,7 +977,7 @@ <h3 id="inputs">
979977
</tr>
980978
<tr>
981979
<td class="col-md-4">
982-
<div class="io-line">Defined in <a href="" data-line="131" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:131</a></div>
980+
<div class="io-line">Defined in <a href="" data-line="128" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:128</a></div>
983981
</td>
984982
</tr>
985983

@@ -1013,7 +1011,7 @@ <h3 id="inputs">
10131011
</tr>
10141012
<tr>
10151013
<td class="col-md-4">
1016-
<div class="io-line">Defined in <a href="" data-line="46" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:46</a></div>
1014+
<div class="io-line">Defined in <a href="" data-line="43" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:43</a></div>
10171015
</td>
10181016
</tr>
10191017

@@ -1047,7 +1045,7 @@ <h3 id="inputs">
10471045
</tr>
10481046
<tr>
10491047
<td class="col-md-4">
1050-
<div class="io-line">Defined in <a href="" data-line="61" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:61</a></div>
1048+
<div class="io-line">Defined in <a href="" data-line="58" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:58</a></div>
10511049
</td>
10521050
</tr>
10531051

@@ -1081,13 +1079,13 @@ <h3 id="inputs">
10811079
</tr>
10821080
<tr>
10831081
<td class="col-md-4">
1084-
<div class="io-line">Defined in <a href="" data-line="31" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:31</a></div>
1082+
<div class="io-line">Defined in <a href="" data-line="28" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:28</a></div>
10851083
</td>
10861084
</tr>
10871085

10881086
<tr>
10891087
<td class="col-md-4">
1090-
<div class="io-description"><p>See See <a href="../classes/Client.html#stompVersions">Client#stompVersions</a>.</p>
1088+
<div class="io-description"><p>See <a href="../classes/Client.html#stompVersions">Client#stompVersions</a>.</p>
10911089
</div>
10921090
</td>
10931091
</tr>
@@ -1115,7 +1113,7 @@ <h3 id="inputs">
11151113
</tr>
11161114
<tr>
11171115
<td class="col-md-4">
1118-
<div class="io-line">Defined in <a href="" data-line="36" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:36</a></div>
1116+
<div class="io-line">Defined in <a href="" data-line="33" class="link-to-prism">consolidated/stompjs/src/stomp-config.ts:33</a></div>
11191117
</td>
11201118
</tr>
11211119

@@ -1156,9 +1154,6 @@ <h3 id="inputs">
11561154
* field by the same name in {@link Client}. This can be passed to
11571155
* the constructor of {@link Client} or to [Client#configure]{@link Client#configure}.
11581156
*
1159-
* There used to be a class with the same name in &#x60;@stomp/ng2-stompjs&#x60;, which has been replaced by
1160-
* {@link RxStompConfig} and {@link InjectableRxStompConfig}.
1161-
*
11621157
* Part of &#x60;@stomp/stompjs&#x60;.
11631158
*/
11641159
export class StompConfig {
@@ -1168,7 +1163,7 @@ <h3 id="inputs">
11681163
public brokerURL?: string;
11691164

11701165
/**
1171-
* See See [Client#stompVersions]{@link Client#stompVersions}.
1166+
* See [Client#stompVersions]{@link Client#stompVersions}.
11721167
*/
11731168
public stompVersions?: Versions;
11741169

‎api-docs/develop/classes/Versions.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,9 @@ <h3 id="constructor">Constructor</h3>
156156

157157
<tr>
158158
<td class="col-md-4">
159-
<div class="io-description"><p>Takes an array of string of versions, typical elements &#39;1.0&#39;, &#39;1.1&#39;, or &#39;1.2&#39;</p>
160-
<p>You will an instance if this class if you want to override supported versions to be declared during
161-
STOMP handshake.</p>
159+
<div class="io-description"><p>Takes an array of versions, typical elements &#39;1.2&#39;, &#39;1.1&#39;, or &#39;1.0&#39;</p>
160+
<p>You will be creating an instance of this class if you want to override
161+
supported versions to be declared during STOMP handshake.</p>
162162
</div>
163163
<div>
164164
<b>Parameters :</b>
@@ -461,10 +461,10 @@ <h3 id="methods">
461461
]);
462462

463463
/**
464-
* Takes an array of string of versions, typical elements &#x27;1.0&#x27;, &#x27;1.1&#x27;, or &#x27;1.2&#x27;
464+
* Takes an array of versions, typical elements &#x27;1.2&#x27;, &#x27;1.1&#x27;, or &#x27;1.0&#x27;
465465
*
466-
* You will an instance if this class if you want to override supported versions to be declared during
467-
* STOMP handshake.
466+
* You will be creating an instance of this class if you want to override
467+
* supported versions to be declared during STOMP handshake.
468468
*/
469469
constructor(public versions: string[]) {}
470470

‎api-docs/develop/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@
3434

3535
<h1 id="navigating-through-the-api-docs">Navigating through the API docs</h1>
3636
<p>These docs correspond to development versions. Please see <a href="../latest/">api-docs</a> for NPM released versions.</p>
37-
<p>The API docs cover three libraries:</p>
37+
<p>The API docs cover the following libraries:</p>
3838
<ul>
3939
<li>@stomp/stompjs</li>
40-
<li>@stomp/rx-stomp - builds over @stomp/stompjs</li>
40+
<li>@stomp/rx-stomp - builds over @stomp/stompjs with RxJS primitives</li>
4141
</ul>
4242
<p>The documentation for classes also indicates which library each of the classes
4343
belongs. See the <a href="/">guides</a> for more information and tutorials.</p>

‎api-docs/develop/interfaces/IMessage.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ <h3>Description</h3>
7676
<p class="comment">
7777
<p>Instance of Message will be passed to <a href="../classes/Client.html#subscribe">subscription callback</a>
7878
and <a href="../classes/Client.html#onUnhandledMessage">Client#onUnhandledMessage</a>.
79-
Since it is an extended <a href="FrameImpl">FrameImpl</a>, you can access <a href="FrameImpl#headers">headers</a>
80-
and <a href="FrameImpl#body">body</a> as properties.</p>
79+
Since it is an extended <a href="../interfaces/IFrame.html">IFrame</a>, you can access <a href="../interfaces/IFrame.html#headers">headers</a>
80+
and <a href="../interfaces/IFrame.html#body">body</a> as properties.</p>
8181
<p>Part of <code>@stomp/stompjs</code>.</p>
8282
<p>See <a href="../classes/Client.html#subscribe">Client#subscribe</a> for example.</p>
8383

@@ -216,8 +216,8 @@ <h3 id="inputs">Properties</h3>
216216
/**
217217
* Instance of Message will be passed to [subscription callback]{@link Client#subscribe}
218218
* and [Client#onUnhandledMessage]{@link Client#onUnhandledMessage}.
219-
* Since it is an extended {@link FrameImpl}, you can access [headers]{@link FrameImpl#headers}
220-
* and [body]{@link FrameImpl#body} as properties.
219+
* Since it is an extended {@link IFrame}, you can access [headers]{@link IFrame#headers}
220+
* and [body]{@link IFrame#body} as properties.
221221
*
222222
* Part of &#x60;@stomp/stompjs&#x60;.
223223
*

‎api-docs/develop/interfaces/IPublishParams.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ <h3 id="inputs">Properties</h3>
347347

348348
<tr>
349349
<td class="col-md-4">
350-
<div class="io-description"><p>By default a <code>content-length</code> header will be added in the Frame to the broker.
350+
<div class="io-description"><p>By default, a <code>content-length</code> header will be added in the Frame to the broker.
351351
Set it to <code>true</code> for the header to be skipped.</p>
352352
</div>
353353
</td>
@@ -365,7 +365,7 @@ <h3 id="inputs">Properties</h3>
365365
import { Versions } from &#x27;./versions.js&#x27;;
366366

367367
/**
368-
* This callback will receive a &#x60;string&#x60; as parameter.
368+
* This callback will receive a &#x60;string&#x60; as a parameter.
369369
*
370370
* Part of &#x60;@stomp/stompjs&#x60;.
371371
*/
@@ -425,7 +425,7 @@ <h3 id="inputs">Properties</h3>
425425
*/
426426
binaryBody?: Uint8Array;
427427
/**
428-
* By default a &#x60;content-length&#x60; header will be added in the Frame to the broker.
428+
* By default, a &#x60;content-length&#x60; header will be added in the Frame to the broker.
429429
* Set it to &#x60;true&#x60; for the header to be skipped.
430430
*/
431431
skipContentLengthHeader?: boolean;

‎api-docs/develop/js/search/search_index.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)