Skip to content
This repository

Stomp client for Web browsers and node.js apps

fix UTF-8 encoding

add the BOM to the file to ensure the UTF-8 strings in the file are
properly decoded
latest commit 54bb48c6e7
Jeff Mesnil authored
Octocat-spinner-32 browsertests fix UTF-8 encoding April 11, 2014
Octocat-spinner-32 doc Add support for node.js September 25, 2013
Octocat-spinner-32 example Add support for node.js September 25, 2013
Octocat-spinner-32 lib fixes node's WebSocketClient onclose March 26, 2014
Octocat-spinner-32 src fixes node's WebSocketClient onclose March 26, 2014
Octocat-spinner-32 test Add support for node.js September 25, 2013
Octocat-spinner-32 .gitignore refactor client.connect() arguments August 08, 2013
Octocat-spinner-32 .travis.yml add coffeelint validation to npm test November 22, 2012
Octocat-spinner-32 Cakefile Add support for node.js September 25, 2013
Octocat-spinner-32 LICENSE.txt add APL2 and README files January 22, 2010
Octocat-spinner-32 README.md Add support for node.js September 25, 2013
Octocat-spinner-32 RELEASE_NOTES.md update release notes November 29, 2012
Octocat-spinner-32 coffeelint.json Travis CI support October 30, 2012
Octocat-spinner-32 index.js fix some formatting September 25, 2013
Octocat-spinner-32 package.json prepare version after 2.3.1 February 18, 2014
README.md

STOMP.js

This library provides a STOMP client for Web browser (using Web Sockets) or node.js applications (either using raw TCP sockets or Web Sockets).

Web Browser support

The library file is located in lib/stomp.js (a minified version is available in lib/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 (including the annotated source code).

node.js support

Install the 'stompjs' module

$ npm install stompjs

In the node.js app, require the module with:

var Stomp = require('stompjs');

To connect to a STOMP broker over a TCP socket, use the Stomp.overTCP(host, port) method:

var client = Stomp.overTCP('localhost', 61613);

To connect to a STOMP broker over a WebSocket, use instead the Stomp.overWS(url) method:

var client = Stomp.overWS('ws://localhost:61614');

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

Build Status

To build JavaScript from the CoffeeScript source code:

$ 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.

Authors

Something went wrong with that request. Please try again.