|
1 | 1 | ---
|
2 |
| -layout: home |
| 2 | +layout: single |
| 3 | +date: 2020-10-19 19:42:22 +0530 |
| 4 | +title: "StompJs Family" |
| 5 | +author_profile: true |
3 | 6 | ---
|
| 7 | + |
| 8 | +These libraries provide [STOMP] over |
| 9 | +[Websocket] connectivity for web-browsers or any other Javascript based |
| 10 | +environments. |
| 11 | + |
| 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+). |
| 18 | + |
| 19 | +## Getting started |
| 20 | + |
| 21 | +Please try the following guides: |
| 22 | + |
| 23 | +- [Using StompJS] - a step by step guide. |
| 24 | +- [Using ng2-stompjs with Angular] - originally written for Angular7, |
| 25 | + recently tested with Angular. |
| 26 | + Many concepts apply to [rx-stomp] as well. |
| 27 | +- Guide to [Connection status in ng2-stompjs]. |
| 28 | + |
| 29 | +Samples: |
| 30 | + |
| 31 | +- [Samples](https://github.com/stomp-js/samples/) for [stompjs] and [rx-stomp]. |
| 32 | +- [Sample](https://github.com/stomp-js/ng2-stompjs-angular7) for [ng2-stompjs] and [rx-stomp]. |
| 33 | + |
| 34 | +[API documentation](/api-docs/latest/) for NPM released versions. |
| 35 | + |
| 36 | +## Upgrading |
| 37 | + |
| 38 | +- [Upgrading StompJS] to update to stompjs@v5 from any of the older versions. |
| 39 | +- [Upgrading to ng2-stompjs@7] for any of the older versions. |
| 40 | + |
| 41 | +## Other topics |
| 42 | + |
| 43 | +- Read the [FAQs], these cover quite varied topics. |
| 44 | +- List of [Pollyfills] - you may need for some environments. |
| 45 | +- Set of additional notes for using these libraries with [SockJS]. |
| 46 | +- One of my favourites, but not widely used, special support for |
| 47 | + [Remote Procedure Calls]. |
| 48 | +- An article devoted to specific issues posed by [React Native]. |
| 49 | + |
| 50 | + |
| 51 | + |
| 52 | +[STOMP]: https://stomp.github.io/index.html |
| 53 | +[Websocket]: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket |
| 54 | +[RxJS]: https://github.com/ReactiveX/RxJS |
| 55 | + |
| 56 | +[stompjs]: https://github.com/stomp-js/stompjs |
| 57 | +[rx-stomp]: https://github.com/stomp-js/rx-stomp |
| 58 | +[ng2-stompjs]: https://github.com/stomp-js/ng2-stompjs |
| 59 | + |
| 60 | +[Pollyfills]: {% link _posts/2018-06-28-pollyfils-for-stompjs-v5.md %} |
| 61 | +[Using StompJS]: {% link _posts/2018-06-29-using-stompjs-v5.md %} |
| 62 | +[Upgrading StompJS]: {% link _posts/2018-09-08-upgrading-stompjs.md %} |
| 63 | +[SockJS]: {% link _posts/2018-09-10-using-stomp-with-sockjs.md %} |
| 64 | +[Remote Procedure Calls]: {% link _posts/2018-10-12-remote-procedure-call.md %} |
| 65 | +[Using ng2-stompjs with Angular]: {% link _posts/2018-11-04-ng2-stomp-with-angular7.md %} |
| 66 | +[Upgrading to ng2-stompjs@7]: {% link _posts/2018-11-05-migrate-ng2-stompjs-v7.md %} |
| 67 | +[Connection status in ng2-stompjs]: {% link _posts/2018-12-18-connection-status-ng2-stompjs.md %} |
| 68 | +[FAQs]: {% link _posts/2019-05-20-faqs.html %} |
| 69 | +[React Native]: {% link _posts/2019-06-10-react-native-additional-notes.md %} |
0 commit comments