This library provides a WebSocket over STOMP client for Web browser or node.js applications.
This library allows you to connect to a STOMP broker over WebSocket. This library supports full STOMP specifications and all current protocol variants. Most of popular messaging brokers support STOMP and STOMP over WebSockets either natively or using plugins.
In general JavaScript engines at browsers are not amenable to binary protocols, so using STOMP, which is a text oriented protocol, becomes a reliable option.
This library was originally developed by Jeff Mesnil.
This library is feature complete and has been in use in production for many years. It is actively maintained. You are welcome to file issues and submit pull requests.
The documentation is hosted as GitHub pages. You may head straight to the entry point. (or with frames)
This library comes with a detailed usage instructions. Please find it at Usage instructions.
If you were using older versions and wish to benefit from newer features, head to Upgrading.
If you are existing user and will like to deep dive - API Reference for important entities:
If you are using this library in NodeJS you should definitely check NodeJS Legacy.
https://github.com/stomp-js/ng2-stompjs is based on this library and exposes entire functionality offered by this library as Angular Services and rxjs Observables. Both these libraries are maintained by similar set of contributors.
The npm package includes TypeScript definitions, no need no install separately.
Please visit Change Log.
If you want to understand the code, develop, contribute. Please visit How to contribute.
License - Apache v2 License