Skip to content

Commit 7614ce9

Browse files
kum-deepakkum-deepak
committed
Committed by Github action
master: { "stompjs": "6.1.2", "rx-stomp": "1.1.4", "ng2-stompjs": "8.0.0" } develop: { "stompjs": "7.0.0-beta2", "rx-stomp": "2.0.0-beta1", "ng2-stompjs": "8.0.0" }
1 parent f51efc2 commit 7614ce9

File tree

10 files changed

+423
-258
lines changed

10 files changed

+423
-258
lines changed

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

Lines changed: 129 additions & 92 deletions
Large diffs are not rendered by default.

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

Lines changed: 58 additions & 42 deletions
Large diffs are not rendered by default.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ <h3>File</h3>
7171
<h3>Description</h3>
7272
</p>
7373
<p class="comment">
74-
<p>RPC Config. See the guide for example.</p>
74+
<p>RPC Config. For examples see the <a href="/guide/rx-stomp/ng2-stompjs/remote-procedure-call.html">guide</a>.</p>
7575

7676
</p>
7777

@@ -205,7 +205,7 @@ <h3 id="inputs">
205205
import { RxStomp } from &#x27;./rx-stomp.js&#x27;;
206206

207207
/**
208-
* See the guide for example
208+
* For examples see the [guide](/guide/rx-stomp/ng2-stompjs/remote-procedure-call.html).
209209
*
210210
* Part of &#x60;@stomp/rx-stomp&#x60;
211211
*/
@@ -215,7 +215,7 @@ <h3 id="inputs">
215215
) &#x3D;&gt; Observable&lt;IMessage&gt;;
216216

217217
/**
218-
* RPC Config. See the guide for example.
218+
* RPC Config. For examples see the [guide](/guide/rx-stomp/ng2-stompjs/remote-procedure-call.html).
219219
*/
220220
export class RxStompRPCConfig {
221221
/**

‎api-docs/develop/injectables/InjectableRxStompConfig.html

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ <h3 id="inputs">
236236
</tr>
237237
<tr>
238238
<td class="col-md-4">
239-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:121</a></code>
239+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:133</a></code>
240240
</div>
241241
</td>
242242
</tr>
@@ -277,21 +277,21 @@ <h3 id="inputs">
277277
</tr>
278278
<tr>
279279
<td class="col-md-4">
280-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:167</a></code>
280+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:179</a></code>
281281
</div>
282282
</td>
283283
</tr>
284284

285285
<tr>
286286
<td class="col-md-4">
287-
<div class="io-description"><p>Callback, invoked on before a connection connection to the STOMP broker.</p>
288-
<p>You can change configuration of the rxStomp, which will impact the immediate connect.
287+
<div class="io-description"><p>Callback, invoked before attempting connection to the STOMP broker.</p>
288+
<p>You can change the configuration of the rxStomp, which will impact the immediate connecting.
289289
It is valid to call <a href="../classes/RxStomp.html#deactivate">RxStomp#deactivate</a> in this callback.</p>
290290
<p>As of version 0.1.1, this callback can be
291291
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function">async</a>
292292
(i.e., it can return a
293293
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>).
294-
In that case connect will be called only after the Promise is resolved.
294+
In that case, connect will be called only after the Promise is resolved.
295295
This can be used to reliably fetch credentials, access token etc. from some other service
296296
in an asynchronous way.</p>
297297
<p>As of 0.3.5, this callback will receive <a href="../classes/RxStomp.html">RxStomp</a> as parameter.</p>
@@ -374,7 +374,7 @@ <h3 id="inputs">
374374
</tr>
375375
<tr>
376376
<td class="col-md-4">
377-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:140</a></code>
377+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:152</a></code>
378378
</div>
379379
</td>
380380
</tr>
@@ -418,16 +418,17 @@ <h3 id="inputs">
418418
</tr>
419419
<tr>
420420
<td class="col-md-4">
421-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:81</a></code>
421+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:93</a></code>
422422
</div>
423423
</td>
424424
</tr>
425425

426426
<tr>
427427
<td class="col-md-4">
428428
<div class="io-description"><p>Will retry if Stomp connection is not established in specified milliseconds.
429-
Default 0, which implies wait for ever.</p>
429+
Default 0, which implies wait forever.</p>
430430
<p>Maps to: <a href="../classes/Client.html#connectionTimeout">Client#connectionTimeout</a>.</p>
431+
<p>Caution: This feature is experimental.</p>
431432
</div>
432433
</td>
433434
</tr>
@@ -461,7 +462,7 @@ <h3 id="inputs">
461462
</tr>
462463
<tr>
463464
<td class="col-md-4">
464-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:178</a></code>
465+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:190</a></code>
465466
</div>
466467
</td>
467468
</tr>
@@ -507,15 +508,18 @@ <h3 id="inputs">
507508
</tr>
508509
<tr>
509510
<td class="col-md-4">
510-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:50</a></code>
511+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:60</a></code>
511512
</div>
512513
</td>
513514
</tr>
514515

515516
<tr>
516517
<td class="col-md-4">
517-
<div class="io-description"><p>Enable client debugging?</p>
518-
</div>
518+
<div class="io-description"><p>Enable client debugging</p>
519+
<p>Example:</p>
520+
<div><pre class="line-numbers"><code class="language-typescript"> debug: (msg: string): void =&gt; {
521+
console.log(new Date(), msg);
522+
},</code></pre></div></div>
519523
</td>
520524
</tr>
521525

@@ -548,7 +552,7 @@ <h3 id="inputs">
548552
</tr>
549553
<tr>
550554
<td class="col-md-4">
551-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:131</a></code>
555+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:143</a></code>
552556
</div>
553557
</td>
554558
</tr>
@@ -589,7 +593,7 @@ <h3 id="inputs">
589593
</tr>
590594
<tr>
591595
<td class="col-md-4">
592-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:147</a></code>
596+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:159</a></code>
593597
</div>
594598
</td>
595599
</tr>
@@ -631,7 +635,7 @@ <h3 id="inputs">
631635
</tr>
632636
<tr>
633637
<td class="col-md-4">
634-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:116</a></code>
638+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:128</a></code>
635639
</div>
636640
</td>
637641
</tr>
@@ -672,7 +676,7 @@ <h3 id="inputs">
672676
</tr>
673677
<tr>
674678
<td class="col-md-4">
675-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:95</a></code>
679+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:107</a></code>
676680
</div>
677681
</td>
678682
</tr>
@@ -714,7 +718,7 @@ <h3 id="inputs">
714718
</tr>
715719
<tr>
716720
<td class="col-md-4">
717-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:102</a></code>
721+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:114</a></code>
718722
</div>
719723
</td>
720724
</tr>
@@ -764,8 +768,8 @@ <h3 id="inputs">
764768
<tr>
765769
<td class="col-md-4">
766770
<div class="io-description"><p>Set it to log the actual raw communication with the broker.
767-
When unset, it logs headers of the parsed frames.</p>
768-
<p>Change in this effects from next broker reconnect.</p>
771+
When unset, it logs only the headers of the parsed frames.</p>
772+
<p>Change in this takes effect from the next broker reconnection.</p>
769773
<p><strong>Caution: this assumes that frames only have valid UTF8 strings.</strong></p>
770774
<p>Maps to: <a href="../classes/Client.html#logRawCommunication">Client#logRawCommunication</a>.</p>
771775
</div>
@@ -801,7 +805,7 @@ <h3 id="inputs">
801805
</tr>
802806
<tr>
803807
<td class="col-md-4">
804-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:126</a></code>
808+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:138</a></code>
805809
</div>
806810
</td>
807811
</tr>
@@ -842,7 +846,7 @@ <h3 id="inputs">
842846
</tr>
843847
<tr>
844848
<td class="col-md-4">
845-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:88</a></code>
849+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:100</a></code>
846850
</div>
847851
</td>
848852
</tr>
@@ -884,16 +888,16 @@ <h3 id="inputs">
884888
</tr>
885889
<tr>
886890
<td class="col-md-4">
887-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:111</a></code>
891+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:123</a></code>
888892
</div>
889893
</td>
890894
</tr>
891895

892896
<tr>
893897
<td class="col-md-4">
894-
<div class="io-description"><p>Enable non-standards compliant mode of splitting of outgoing large text packets.
898+
<div class="io-description"><p>Enable a non-standards compliant mode of splitting outgoing large text packets.
895899
See <a href="../classes/Client.html#splitLargeFrames">Client#splitLargeFrames</a> for details.
896-
Useful with Java Spring based brokers.</p>
900+
Probably, only Java Spring based brokers support this mode.</p>
897901
<p>Maps to: <a href="../classes/Client.html#splitLargeFrames">Client#splitLargeFrames</a>.</p>
898902
</div>
899903
</td>
@@ -935,10 +939,10 @@ <h3 id="inputs">
935939

936940
<tr>
937941
<td class="col-md-4">
938-
<div class="io-description"><p>STOMP versions to attempt during STOMP handshake. By default versions <code>1.0</code>, <code>1.1</code>, and <code>1.2</code> are attempted.</p>
942+
<div class="io-description"><p>STOMP versions to attempt during STOMP handshake. By default, versions <code>1.2</code>, <code>1.1</code>, and <code>1.0</code> are attempted.</p>
939943
<p>Example:</p>
940-
<div><pre class="line-numbers"><code class="language-javascript"> // Try only versions 1.0 and 1.1
941-
rxStompConfig.stompVersions= new Versions([&#39;1.0&#39;, &#39;1.1&#39;]);</code></pre></div><p>Maps to: <a href="../classes/Client.html#stompVersions">Client#stompVersions</a></p>
944+
<div><pre class="line-numbers"><code class="language-javascript"> // Try only versions 1.1 and 1.0
945+
rxStompConfig.stompVersions= new Versions([&#39;1.1&#39;, &#39;1.0&#39;]);</code></pre></div><p>Maps to: <a href="../classes/Client.html#stompVersions">Client#stompVersions</a></p>
942946
</div>
943947
</td>
944948
</tr>
@@ -972,7 +976,7 @@ <h3 id="inputs">
972976
</tr>
973977
<tr>
974978
<td class="col-md-4">
975-
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:73</a></code>
979+
<div class="io-line">Defined in <code><a href="../classess/RxStompConfig.html#source" target="_self" >RxStompConfig:83</a></code>
976980
</div>
977981
</td>
978982
</tr>

0 commit comments

Comments
 (0)