| 1 | # STOMP.js
|
| 2 |
|
| 3 | [](https://travis-ci.org/stomp-js/stompjs)
|
| 4 |
|
| 5 | This library provides a STOMP over WebSocket client for Web browser and node.js applications.
|
| 6 |
|
| 7 | # Introduction
|
| 8 |
|
| 9 | This repository is for version 5 and above of this library.
|
| 10 | Lower versions are not supported any longer.
|
| 11 |
|
| 12 | This library allows you to connect to a STOMP broker over WebSocket. This library
|
| 13 | supports complete STOMP specifications including all current protocol variants. Most
|
| 14 | popular messaging brokers support STOMP and STOMP over WebSockets either natively
|
| 15 | or using plugins.
|
| 16 |
|
| 17 | In general JavaScript engines in browsers are not friendly to binary protocols,
|
| 18 | so using STOMP is a good option because it is a text-oriented protocol.
|
| 19 |
|
| 20 | This library has its roots in a version released by [Jeff Mesnil](http://jmesnil.net/).
|
| 21 |
|
| 22 | ## Current Status
|
| 23 |
|
| 24 | Version 5 of this library has been bottom-up rewritten using TypeScript (versions 3/4
|
| 25 | use CoffeeScript). The code has substantially changed, so, while there is a compatibility
|
| 26 | mode, you might need to update your code.
|
| 27 |
|
| 28 | This library is feature complete and has been used in production for many years. It
|
| 29 | is actively maintained. You are welcome to file issues and submit pull requests.
|
| 30 |
|
| 31 | ## Getting started
|
| 32 |
|
| 33 | The API documentation is hosted as GitHub pages for the entire StompJS family of libraries.
|
| 34 | You may head straight to the https://stomp-js.github.io/api-docs/latest/
|
| 35 |
|
| 36 | This library comes with detailed usage instructions. Please find it at
|
| 37 | [Usage instructions](https://stomp-js.github.io/guide/stompjs/using-stompjs-v5.html).
|
| 38 | Check out other guides at https://stomp-js.github.io/.
|
| 39 |
|
| 40 | There are quite detailed API documentation,
|
| 41 | you should start at https://stomp-js.github.io/api-docs/latest/classes/Client.html.
|
| 42 |
|
| 43 | ## Upgrading
|
| 44 |
|
| 45 | if you were using an older version of this library, you would need to make changes
|
| 46 | to your code. Head to
|
| 47 | [Upgrading](https://stomp-js.github.io/#upgrading).
|
| 48 |
|
| 49 | ## Usage with RxJS
|
| 50 |
|
| 51 | https://github.com/stomp-js/rx-stomp is based on this library and exposes the entire functionality
|
| 52 | offered by this library as RxJS Observables.
|
| 53 |
|
| 54 | ## Usage with Angular2+
|
| 55 |
|
| 56 | https://github.com/stomp-js/ng2-stompjs is based on https://github.com/stomp-js/rx-stomp
|
| 57 | and exposes key classes as Angular Injectable Services.
|
| 58 |
|
| 59 | ## TypeScript definitions
|
| 60 |
|
| 61 | The npm package includes TypeScript definitions, so there is no need no install it separately.
|
| 62 |
|
| 63 | ## Change-log
|
| 64 |
|
| 65 | Please visit [Change Log](Change-log.md).
|
| 66 |
|
| 67 | ## Contributing
|
| 68 |
|
| 69 | If you want to understand the code, develop, or contribute. Please visit
|
| 70 | [How to contribute](Contribute.md).
|
| 71 |
|
| 72 | ## Authors
|
| 73 |
|
| 74 | - [Jeff Mesnil](http://jmesnil.net/)
|
| 75 | - [Jeff Lindsay](http://github.com/progrium)
|
| 76 | - [Vanessa Williams](http://github.com/fridgebuzz)
|
| 77 | - [Deepak Kumar](https://github.com/kum-deepak)
|
| 78 | - [Astha Deep](https://github.com/astha183)
|
| 79 | - [Dillon Sellars](https://github.com/dillon-sellars)
|
| 80 | - [Jimi Charalampidis](https://github.com/jimic)
|
| 81 | - [Raul](https://github.com/rulonder)
|
| 82 | - [Dimitar Georgiev](https://github.com/iMitaka)
|
| 83 | - [Genadi](https://github.com/genadis)
|
| 84 | - [Bobohuochai](https://github.com/bobohuochai)
|
| 85 | - [Sailai](https://github.com/sailai)
|
| 86 |
|
| 87 | ## License
|
| 88 |
|
| 89 | [License](LICENSE) - Apache-2.0
|