Skip to content

Commit 4ba39c4

Browse files
committed
Deprecate ng2-stompjs
1 parent b0f2a9e commit 4ba39c4

5 files changed

+25
-38
lines changed
Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
---
2-
question: 'I am using Angular, which of stompjs, rx-stomp, or ng2-stompjs should I use?'
2+
question: 'I am using Angular. Which of stompjs or rx-stomp should I use?'
33
group: General
44
priority: ACE
55
---
66

7-
Angular makes heavy use of [RxJS](https://github.com/ReactiveX/RxJS),
8-
Using `rx-stomp` or `ng2-stompjs` should feel natural with Angular.
7+
Angular makes heavy use of [RxJS](https://github.com/ReactiveX/RxJS). So using `rx-stomp` should feel natural with Angular.
98

10-
If you are going to use [Angular Dependency Injection](https://angular.io/guide/dependency-injection),
11-
`ng2-stompjs` would be the way to go.
12-
`ng2-stompjs` makes `rx-stomp` classes Injectable and sets up some factories.
9+
There is a tutorial for using `rx-stomp` with Angular. Please see [guides](/#getting-started).
1310

14-
Having said all of these, you can actually use any of the variants.
11+
Having said all of these, you can use any of the variants.
1512
Developers have reported successfully using `stompjs` directly with Angular.

_faqs/general-tree-shaking.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ priority: ADM
66

77
Yes.
88

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.
1210

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`.

_faqs/general-what-documentation-is-available.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,5 @@ priority: AAC
66

77
- Comprehensive [API documentation](/api-docs/latest/).
88
- Several [guides](/).
9-
- [Samples](https://github.com/stomp-js/samples/) for `@stomp/stompjs`.
10-
- [Sample](https://github.com/stomp-js/ng2-stompjs-angular7) for `@stompjs/rx-stomp`
11-
and `@stomp/ng2-stompjs`.
9+
- [Samples](https://github.com/stomp-js/samples/) for `@stomp/stompjs` and `@stompjs/rx-stomp`.
10+
- [Sample](https://github.com/stomp-js/rx-stomp-angular) for using `@stompjs/rx-stomp` with Angular.
Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
---
2-
question: 'Which one I should use - stompjs, rx-stomp, or ng2-stompjs?'
2+
question: 'Which one should I use - stompjs or rx-stomp?'
33
group: General
44
priority: ACA
55
---
66

7-
`stompjs` is the core underlying library, usable almost everywhere.
7+
`stompjs` is the underlying core library, usable almost everywhere.
88

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`.
1210

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.
12+
13+
[RxJS]: https://github.com/ReactiveX/RxJS

index.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,49 +5,42 @@ title: 'StompJs Family'
55
author_profile: true
66
---
77

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.
119

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].
1811

1912
## Getting started
2013

2114
Please try the following guides:
2215

23-
- [Using StompJS] - a step by step guide.
16+
- [Using StompJS] - a step-by-step guide.
2417
- [Using rx-stomp with Angular] - Preferred, originally written for Angular13,
25-
should work with Angular 8+.
18+
should work with Angular 7+.
2619
- [Using ng2-stompjs with Angular] - Deprecated, originally written for Angular7,
2720
last tested with Angular 9.
28-
Many concepts apply to [rx-stomp] as well.
2921
- Guide to [Connection status in ng2-stompjs].
3022

3123
Samples:
3224

3325
- [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+.
3527

3628
[API documentation](/api-docs/latest/) for NPM released versions.
3729

3830
## Upgrading
3931

32+
- [Migrate ng2-stompjs to rx-stomp] - migrate Angular projects to use [rx-stomp].
4033
- [Upgrading to stompjs@6, rx-stomp@1, ng2-stompjs@8] - update from
4134
stompjs@v5, [email protected], ng2-stompjs@7.
4235
- [Upgrading StompJS] to update to stompjs@v5 from any of the older versions.
4336
- [Upgrading to ng2-stompjs@7] for any of the older versions.
4437

4538
## Other topics
4639

47-
- Read the [FAQs], these cover quite varied topics.
40+
- Read the [FAQs]. These cover varied topics.
4841
- List of [Pollyfills] - you may need for some environments.
4942
- Set of additional notes for using these libraries with [SockJS].
50-
- One of my favourites, but not widely used, special support for
43+
- One of my favorites, but not widely used, exceptional support for
5144
[Remote Procedure Calls].
5245
- An article devoted to specific issues posed by [React Native].
5346

@@ -70,3 +63,4 @@ Samples:
7063
[FAQs]: {% link _posts/2019-05-20-faqs.html %}
7164
[React Native]: {% link _posts/2019-06-10-react-native-additional-notes.md %}
7265
[Upgrading to stompjs@6, rx-stomp@1, ng2-stompjs@8]: {% link _posts/2020-10-21-upgrading-to-stompjs-6-rx-stomp-1.md %}
66+
[Migrate ng2-stompjs to rx-stomp]: {% link _posts/2022-03-03-ng2-stompjs-to-rx-stomp.md %}

0 commit comments

Comments
 (0)