STOMP.js Family

These libraries provide STOMP over WebSocket connectivity for web browsers and other JavaScript runtimes.

stompjs is the core JavaScript library. rx-stomp is a wrapper that exposes the same functionality as RxJS primitives. If you already use RxJS or prefer reactive patterns, start with rx-stomp.

Getting started

Start here:

• Using StompJS - a step-by-step guide.
• Using rx-stomp with Angular — originally written for Angular 13; works with Angular 7+.
• Guide to Connection status in RxStomp.
• Guide to How to Use RxStomp with React.

All of these guides are written by the maintainers 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.
• Upgrading from old versions — to upgrade from versions 2, 3, or 4.

Other topics

• Read the FAQs — a curated list of common questions and answers.
• List of Polyfills — you may need these in some environments.
• Notes on using these libraries with SockJS.
• Support for Remote Procedure Calls — powerful but less commonly used.
• Notes for using these libraries with React Native.