Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hcsalis/vertx3-eventbus-rx-client
RxJS powered Event Bus client for Vert.x 3
https://github.com/hcsalis/vertx3-eventbus-rx-client
client eventbus reactive rx rxjs sockjs typescript vertx vertx3 vertx3-eventbus-client
Last synced: about 2 months ago
JSON representation
RxJS powered Event Bus client for Vert.x 3
- Host: GitHub
- URL: https://github.com/hcsalis/vertx3-eventbus-rx-client
- Owner: hcsalis
- License: mit
- Archived: true
- Created: 2017-05-06T19:53:26.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-24T19:47:33.000Z (over 6 years ago)
- Last Synced: 2024-09-21T12:30:54.404Z (about 2 months ago)
- Topics: client, eventbus, reactive, rx, rxjs, sockjs, typescript, vertx, vertx3, vertx3-eventbus-client
- Language: TypeScript
- Homepage:
- Size: 184 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/hcsalis/vertx3-eventbus-rx-client)
[](https://coveralls.io/github/hcsalis/vertx3-eventbus-rx-client?branch=master)
[](https://badge.fury.io/js/vertx3-eventbus-rx-client)
[](http://opensource.org/licenses/MIT)
# vertx3-eventbus-rx-client
[RxJS](http://reactivex.io/rxjs/) powered Event Bus client for [Vert.x 3](http://vertx.io/).
This library:
- Offers an API similar to Rxified server counterpart.
- Includes Typescript definitions and provides interfaces for data models (Message, CloseEvent etc.).
- Wraps the official client without side effects, thus can be used together with the official client by providing it as a delegate to the constructor.
- Helps to prevent memory leaks by unsubscribing on disconnect or close (or after receiving a reply in case of rxSend).
- Does not provide features like send with timeout, auto-resubscription etc. because these are trivial to implement with rxjs operators and subjects.
## Getting Started
### Installation
install using npm:
```
npm install vertx3-eventbus-rx-client --save
```
### Peer Dependencies
Make sure you have RxJS 5 and official event bus client (version 3.4.x) as dependencies in your project, or install them as follows:
```
npm install [email protected] --save
```
```
npm install rxjs --save
```
### Usage
import as ES module:
```javascript
import { EventBus } from 'vertx3-eventbus-rx-client';
const eb = EventBus.create('server-address');
```
import as CommonJS module:
```javascript
const RxEB = require('vertx3-eventbus-rx-client');
const eb = RxEB.EventBus.create('server-address');
```
## API
Creating an instance:
```javascript
// by using factory method
const eb = EventBus.create('server-url');
// by wrapping an existing non-Rxified eventbus object
const eb = new EventBus(delegateEB);
```
EventBus state:
```javascript
let ebState;
// get current state
ebState = eb.state;
// get current state and future changes
eb.state$.subscribe(
state => {
ebState = state;
}
);
```
Sending messages:
```javascript
const message = {};
// send a message
eb.send('address', message);
// send and expect a reply
eb.rxSend('address', message).subscribe(
reply => {
// received a reply
},
error => {
// received an error
}
);
```
Message consumer:
```javascript
// register consumer
const subscription = eb.rxConsumer('address').subscribe(
message => {
// received a message
}
);
// un-register consumer
subscription.unsubscribe();
```
Getting close event:
```javascript
// get close event
eb.closeEvent;
// close event is null until State is CLOSED
eb.state$.subscribe(
state => {
if (state !== State.CLOSED) {
console.log(eb.closeEvent); // null
} else {
console.log(eb.closeEvent); // NOT null. Refer to CloseEvent docs on the link below.
}
}
);
```
Full API documentation can be found [HERE](https://hcsalis.github.io/vertx3-eventbus-rx-client/classes/eventbus.html).
## Testing
Run unit tests with:
```
npm run test
```
End-to-end tests should be run against the [Test Server](https://github.com/hcsalis/vertx3-eventbus-rx-client-test-server). Once it is up and running, start the tests with this command:
```
npm run e2e
```
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/hcsalis/vertx3-eventbus-rx-client/blob/master/LICENSE) file for details