Skip to content

Commit d440543

Browse files
committed
Add rx-stomp specific items to upgrade guide.
1 parent 7b6e91a commit d440543

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

_posts/2020-10-21-upgrading-to-stompjs-6-rx-stomp-1.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ to activate it.
3434
client.discardWebsocketOnCommFailure = true;
3535
```
3636

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+
3743
### connectionTimeout
3844

3945
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.
5056
client.connectionTimeout = 500;
5157
```
5258

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+
5365
### deactivate - async
5466

5567
You are unlikely to be affected by this change.
@@ -62,6 +74,28 @@ invoked in quick succession.
6274
If you were calling `deativate` and `activate` in succession,
6375
you should await for `deativate`.
6476

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+
6599
## Non visible changes
66100

67101
- The output target is `es2015`. We wanted `es2017`, however,
@@ -70,3 +104,7 @@ you should await for `deativate`.
70104
In previous version `rx-stomp` used `commonjs` module system,
71105
which, was not very friendly to tree shaking.
72106
- 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

Comments
 (0)