src/rxmq.js
/**
* Rxmq Bus aliases
*/
const BusAliases = {
/**
* Get an Rx.Observable for specific set of topics on a given channel
* @param {Object} options Observe options
* @param {String} options.channel Channel name
* @param {String} options.topic Topic name
* @return {Rx.Observable} Rx.Observable for given set of topics
* @example
* rxmq.observe({
* channel: 'test',
* topic: 'test.topic',
* }).subscribe((res) => { // default Rx.Observable subscription
* // handle response here
* // ...
* });
*/
observe({channel, topic}) {
return this.channel(channel).observe(topic);
},
/**
* Subscribe to specific topic and channel using given handler functions
* @param {Object} options Subscription options
* @param {String} options.channel Channel name
* @param {String} options.topic Topic name
* @param {Function} options.onNext Function handler for Rx.Observable onNext
* @param {Function} options.onError Function handler for Rx.Observable onError
* @param {Function} options.onCompleted Function handler for Rx.Observable onCompleted
* @return {Rx.Disposable} Disposable subscription
* @example
* // init subscription
* const subscription = rxmq.subscribe({
* channel: 'test',
* topic: 'test.topic',
* onNext: (data) => {
* // your code here
* },
* onError: console.error,
* onCompleted: () => console.log('done!'),
* });
* // do work
* // ...
* // cleanup if needed
* subscription.dispose();
*/
subscribe({channel, topic, onNext, onError, onCompleted}) {
return this.channel(channel).observe(topic).subscribe(onNext, onError, onCompleted);
},
/**
* Trigger `.onNext()` for specific topic on specific channel
* @param {Object} options Triggering options
* @param {String} options.channel Channel name
* @param {String} options.topic Topic name
* @param {Any} options.data Data to send
* @return {void}
* @example
* rxmq.onNext({
* channel: 'test',
* topic: 'test.topic',
* data: 'any data here',
* });
*/
onNext({channel, topic, data}) {
this.channel(channel).subject(topic).onNext(data);
},
};
/**
* Rxmq bus aliases definition
*/
export {BusAliases};