StompJs Family

These libraries provide STOMP over Websocket connectivity for web browsers or other Javascript-based environments.

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.

Getting started

Please try the following guides:

• Using StompJS - a step-by-step guide.
• Using rx-stomp with Angular — originally written for Angular13, should work with Angular 7+.
• Guide to Connection status in ng2-stompjs.
• Guide to How to Use RxStomp with React.

All these guides are written by the maintainers of these projects and follow best practices.

Samples:

• Samples for stompjs and rx-stomp.
• Sample for rx-stomp with Angular 7+.
• Sample for rx-stomp with React.

API documentation for NPM released versions.

Upgrading

• Migrate ng2-stompjs to rx-stomp — migrate Angular projects to use rx-stomp.
• Upgrade Guide — upgrade to the most recent versions of stompjs and rx-stomp.
• Upgrading from old versions — to update to stompjs@v5 from any of the older versions.

Other topics

• Read the FAQs. These cover varied topics.
• List of Polyfills — you may need these for some environments.
• Set of additional notes for using these libraries with SockJS.
• One of my favorites, but not widely used, excellent support for Remote Procedure Calls.
• An article devoted to specific issues posed by React Native.