@openrailuk/stomp-client

stomp-client


info

This repository is hosted on GitLab as stomp-client-nodejs. There is no downstream GitHub repository currently. Please raise any issues or pull requests on the GitLab repository.

usage

To use the stomp-client-nodejs package you first need to add it as a dependency to your project by running:

``shell
yarn add @openrailuk/stomp-client --save
`

Once added and installed to your project you can import the client model by using:

`javascript
import { StompClient } from '@openrailuk/stomp-client';
`

To begin receiving live Darwin data you need to initialise the client and subscribe to a queue. The queue name can be found on the National Rail Data Portal on the My Feeds page under the Real Time Feed Information section.

This is an example on how to initialise and subscribe to a queue:

`javascript
import { StompClient } from '@openrailuk/stomp-client';

const client = new StompClient();

client.initialise()
.then(() => {
client.on('error', (err) => {
console.error(err);
});

client.on('message', (data) => {
console.log(data);
});

return client.subscribe(QUEUE_NAME);
})
.then(() => {
console.log('subscribed');
})
.catch((err) => {

});
``

documentation

You might be wondering where to find information about how to use this package, fear not all documentation for open rail packages can be found on the doc site and documentation specific to this package can be found under @openrailuk/stomp-client