Skip to content

Commit e66d2c3

Browse files
committed
Deprecate ng2-stompjs
1 parent 7614ce9 commit e66d2c3

File tree

3 files changed

+4
-23
lines changed

3 files changed

+4
-23
lines changed

api-docs-gen/README-src.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,19 @@ The API docs cover three libraries:
44

55
- @stomp/stompjs
66
- @stomp/rx-stomp - builds over @stomp/stompjs
7-
- @stomp/ng2-stompjs - thin wrapper over @stomp/rx-stomp
87

9-
The documentation for classes indicate which library each of the classes
10-
belong. See the [guides](/) for more information and tutorials.
8+
The documentation for classes also indicates which library each of the classes
9+
belongs. See the [guides](/) for more information and tutorials.
1110

1211
These documents have been generated using [Compodoc](https://compodoc.app/).
1312

1413
## stompjs
1514

1615
Preferred entry point is [Client](./classes/Client.html).
17-
If you are using compatibility mode your entry point would be
16+
If you are using the compatibility mode, your entry point would be
1817
[Stomp](./classes/Stomp.html).
1918

2019
## rx-stomp
2120

2221
Your entry point would be [RxStomp](./classes/RxStomp.html).
2322
For RPC [RxStompRPC](./classes/RxStompRPC.html).
24-
25-
## ng2-stompjs
26-
27-
Injectable versions of `rx-stomp` classes:
28-
29-
- [RxStompService](./injectables/RxStompService.html) for [RxStomp](./classes/RxStomp.html)
30-
- [InjectableRxStompConfig](./injectables/InjectableRxStompConfig.html) for [RxStompConfig](./classes/RxStompConfig.html)
31-
- [RxStompRPCService](./injectables/RxStompRPCService.html) for [RxStompRPC](./classes/RxStompRPC.html)
32-
- [InjectableRxStompRPCConfig](./injectables/InjectableRxStompRPCConfig.html) for [RxStompRPCConfig](./classes/RxStompRPCConfig.html)
33-
- [rxStompServiceFactory](./miscellaneous/functions.html#rxStompServiceFactory)
34-
35-
Deprecated classes:
36-
37-
- [StompRService](./injectables/StompRService.html)
38-
- [StompService](./injectables/StompService.html)

api-docs-gen/authors-src.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,3 @@ stompjs:
1111
- label: 'rx-stomp'
1212
icon: 'fab fa-fw fa-github'
1313
url: 'https://github.com/stomp-js/rx-stomp'
14-
- label: 'ng2-stompjs'
15-
icon: 'fab fa-fw fa-github'
16-
url: 'https://github.com/stomp-js/ng2-stompjs'

api-docs-gen/config.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
export BASE=`dirname $0`/consolidated
2-
export BUNDLES="stompjs rx-stomp ng2-stompjs"
2+
export BUNDLES="stompjs rx-stomp"

0 commit comments

Comments
 (0)