@@ -34,6 +34,12 @@ to activate it.
34
34
client .discardWebsocketOnCommFailure = true ;
35
35
```
36
36
37
+ Ref:
38
+
39
+ - [ Client#discardWebsocketOnCommFailure] ( https://stomp-js.github.io/api-docs/latest/classes/Client.html#discardWebsocketOnCommFailure )
40
+ - [ StompConfig#discardWebsocketOnCommFailure] ( https://stomp-js.github.io/api-docs/latest/classes/StompConfig.html#discardWebsocketOnCommFailure )
41
+ - [ RxStompConfig#discardWebsocketOnCommFailure] ( https://stomp-js.github.io/api-docs/latest/classes/RxStompConfig.html#discardWebsocketOnCommFailure )
42
+
37
43
### connectionTimeout
38
44
39
45
The STOMP standard supports Heartbeats which allows detecting stale connections.
@@ -50,6 +56,12 @@ The value is number of milliseconds to wait for a successful connection.
50
56
client .connectionTimeout = 500 ;
51
57
```
52
58
59
+ Ref:
60
+
61
+ - [ Client#connectionTimeout] ( https://stomp-js.github.io/api-docs/latest/classes/Client.html#connectionTimeout )
62
+ - [ StompConfig#connectionTimeout] ( https://stomp-js.github.io/api-docs/latest/classes/StompConfig.html#connectionTimeout )
63
+ - [ RxStompConfig#connectionTimeout] ( https://stomp-js.github.io/api-docs/latest/classes/RxStompConfig.html#connectionTimeout )
64
+
53
65
### deactivate - async
54
66
55
67
You are unlikely to be affected by this change.
@@ -62,6 +74,28 @@ invoked in quick succession.
62
74
If you were calling ` deativate ` and ` activate ` in succession,
63
75
you should await for ` deativate ` .
64
76
77
+ ### rx-stomp/ng-stomp-js specific
78
+
79
+ [ RxStomp#watch] now allows setting unsubscribe headers.
80
+ These headers can be set as fixed values or a callback that would return headers.
81
+ See [ IWatchParams#unsubHeaders] for details and an example.
82
+
83
+ See:
84
+
85
+ - [ RxStomp#watch]
86
+ - [ IWatchParams#unsubHeaders]
87
+
88
+ #### subscribeOnlyOnce
89
+
90
+ By default when you initiate a watch it will be reestablished in case of
91
+ a reconnection to the broker.
92
+ You can set this flag while initiating a watch to subscribe only once.
93
+
94
+ See:
95
+
96
+ - [ RxStomp#watch]
97
+ - [ IWatchParams#subscribeOnlyOnce]
98
+
65
99
## Non visible changes
66
100
67
101
- The output target is ` es2015 ` . We wanted ` es2017 ` , however,
@@ -70,3 +104,7 @@ you should await for `deativate`.
70
104
In previous version ` rx-stomp ` used ` commonjs ` module system,
71
105
which, was not very friendly to tree shaking.
72
106
- Remove dom lib dependency for usage with NodeJS/Typescript.
107
+
108
+ [ rxstomp#watch ] : https://stomp-js.github.io/api-docs/latest/classes/RxStomp.html#watch
109
+ [ iwatchparams#unsubheaders ] : https://stomp-js.github.io/api-docs/latest/interfaces/IWatchParams.html#unsubHeaders
110
+ [ iwatchparams#subscribeonlyonce ] : https://stomp-js.github.io/api-docs/latest/interfaces/IWatchParams.html#subscribeOnlyOnce
0 commit comments