STOMP Over WebSocket
The library file is located in dist/stomp.js (a minified version is available in dist/stomp.min.js).
It does not require any dependency (except WebSocket support from the browser or an alternative to WebSocket!)
Online documentation describes the library API.
Development Requirements
For development (testing, building) the project requires node.js. This allows us to run tests without the browser continuously during development (see cake watch).
$ npm install
Building and Testing
To build JavaScript:
$ cake build
To run tests:
$ cake test
To continuously run tests on file changes:
$ cake watch
Browser Tests
- Make sure you have a running STOMP broker which supports the WebSocket protocol (see the documentation)
- Open in your web browser the project's test page
- Check all tests pass
Use
The project contains examples for using stomp.js to send and receive STOMP messages from a server directly in the Web Browser or in a WebWorker.