You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _faqs/general-tree-shaking.md
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,8 @@ priority: ADM
6
6
7
7
Yes.
8
8
9
-
The versions - `stomp-js@6`, `rx-stomp@1`, `ng2-stompjs@8` - are targeted to
10
-
`es2015`. This ensures smaller code size.
11
-
The code follows guidelines that should allow proper tree shaking behavior.
9
+
The versions, `stomp-js@6+` and `rx-stomp@1+` are distributed as `es2015` UMD and modules. These lead to small code size and proper tree shaking behavior.
12
10
13
-
`rx-stomp`, prior to v1, was distributed as `commonjs` modules, which
14
-
may not be tree shaking friendly. Please upgrade if you face issues.
11
+
`rx-stomp`, before v1, was distributed as `commonjs` modules, which may not be tree shaking friendly. Please upgrade if you face issues.
12
+
13
+
`ng2-stompjs` is likely to cause issues with newer Angular versions. So, please migrate to `rx-stomp`.
question: 'Which one I should use - stompjs, rx-stomp, or ng2-stompjs?'
2
+
question: 'Which one should I use - stompjsor rx-stomp?'
3
3
group: General
4
4
priority: ACA
5
5
---
6
6
7
-
`stompjs` is the core underlying library, usable almost everywhere.
7
+
`stompjs` is the underlying core library, usable almost everywhere.
8
8
9
-
`rx-stomp` exposes functionality as [RxJS](https://github.com/ReactiveX/RxJS) primitives.
10
-
If you are already using RxJS in your project or familiar with it,
11
-
please consider using `rx-stomp`.
9
+
`rx-stomp` exposes functionality as [RxJS] primitives. If you are already using RxJS in your project or are familiar with it, please consider using `rx-stomp`.
12
10
13
-
`ng2-stompjs` offers same functionally as `rx-stomp`.
14
-
`ng2-stompjs` makes `rx-stomp` classes Injectable and sets up some factories.
15
-
If you are using Angular you should consider this variant.
11
+
Since Angular relies heavily on [RxJS], you should consider `rx-stomp` with Angular.
Copy file name to clipboardExpand all lines: index.md
+9-15Lines changed: 9 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,49 +5,42 @@ title: 'StompJs Family'
5
5
author_profile: true
6
6
---
7
7
8
-
These libraries provide [STOMP] over
9
-
[Websocket] connectivity for web-browsers or any other Javascript based
10
-
environments.
8
+
These libraries provide [STOMP] over [Websocket] connectivity for web browsers or other Javascript-based environments.
11
9
12
-
[stompjs] is the core Javascript library.
13
-
[rx-stomp] is a wrapper that exposes functionality as [RxJS] primitives.
14
-
If you are already using RxJS in your project or familiar with it,
15
-
check out [rx-stomp].
16
-
[ng2-stompjs] makes [rx-stomp] classes Injectable and sets up some factories
17
-
suitable to be used by Angular (2+).
10
+
[stompjs] is the core Javascript library. [rx-stomp] is a wrapper that exposes functionality as [RxJS] primitives. If you are already using RxJS in your project or are familiar with it, check out [rx-stomp].
18
11
19
12
## Getting started
20
13
21
14
Please try the following guides:
22
15
23
-
-[Using StompJS] - a step by step guide.
16
+
-[Using StompJS] - a step-by-step guide.
24
17
-[Using rx-stomp with Angular] - Preferred, originally written for Angular13,
25
-
should work with Angular 8+.
18
+
should work with Angular 7+.
26
19
-[Using ng2-stompjs with Angular] - Deprecated, originally written for Angular7,
27
20
last tested with Angular 9.
28
-
Many concepts apply to [rx-stomp] as well.
29
21
- Guide to [Connection status in ng2-stompjs].
30
22
31
23
Samples:
32
24
33
25
-[Samples](https://github.com/stomp-js/samples/) for [stompjs] and [rx-stomp].
34
-
-[Sample](https://github.com/stomp-js/ng2-stompjs-angular7) for [ng2-stompjs] and [rx-stomp].
26
+
-[Sample](https://github.com/stomp-js/rx-stomp-angular) for [rx-stomp] with Angular 7+.
35
27
36
28
[API documentation](/api-docs/latest/) for NPM released versions.
37
29
38
30
## Upgrading
39
31
32
+
-[Migrate ng2-stompjs to rx-stomp] - migrate Angular projects to use [rx-stomp].
40
33
-[Upgrading to stompjs@6, rx-stomp@1, ng2-stompjs@8] - update from
0 commit comments