https://github.com/xogroup/bunnybus
Enterprise bus facade for creating a data transit system.
https://github.com/xogroup/bunnybus
enterprise-bus javascript messaging nodejs rabbitmq
Last synced: 11 months ago
JSON representation
Enterprise bus facade for creating a data transit system.
- Host: GitHub
- URL: https://github.com/xogroup/bunnybus
- Owner: xogroup
- Created: 2016-12-09T20:45:04.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-24T18:58:03.000Z (about 2 years ago)
- Last Synced: 2025-07-08T18:48:37.110Z (12 months ago)
- Topics: enterprise-bus, javascript, messaging, nodejs, rabbitmq
- Language: JavaScript
- Homepage:
- Size: 683 KB
- Stars: 46
- Watchers: 7
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
Awesome Lists containing this project
README
# bunnybus
BunnyBus is a high level enterprise bus implementation making pub/sub and queue management easy.
Currently supports the following queueing frameworks.
- [RabbitMQ](https://www.rabbitmq.com/)
Lead Maintainer: [Lam Chan](https://github.com/lamchakchan)
## Introduction
BunnyBus abstracts away low level queue driver details such as creating a connection, creating a channel, creating bindings, creating subscribing queues and etc. BunnyBus provides safe defaults for many setups which can also be configured. The core of BunnyBus implements native node callbacks providing maximum performance. BunnyBus provides two flavors of API for callbacks and Promise alike. The BunnyBus CLI can be found [here](https://github.com/xogroup/bunnybus-cli) implementing this core driver.
**If you require strict FIFO behavior** keep in mind that while your handlers will be called in order, if you yield to the event loop you may resolve out of order. BunnyBus contains an optional setting to enforce strict FIFO behavior, but this comes at significant performance penalty and shouldn't be used by most consumers. You can enable this behavior in your bunnybus config by setting `server.dispatchType` to `'serial'`.
## Installation
```
➜ npm i bunnybus
```
## Usage
### Async / Await
```javascript
const BunnyBus = require('bunnybus');
const bunnyBus = new BunnyBus();
//create a subscription
await bunnyBus.subscribe('queue1', {
'create-event' : async (message, ack) => {
console.log(message.comment);
await ack();
}}
);
//publish to the above subscription
await bunnyBus.publish({ event : 'create-event', comment : 'hello world!' });
);
```
## Documentation
### API
See the [API Reference](http://github.com/xogroup/bunnybus/blob/master/API.md).
### Examples
Check out the [Examples](http://github.com/xogroup/bunnybus/blob/master/Example.md).
### Diagrams
[Visual Guide](http://github.com/xogroup/bunnybus/blob/master/Diagram.md) to integrating with `BunnyBus`.
## Articles
* [@Medium](https://medium.com/xo-tech/bunnybus-building-a-data-transit-system-b9647f6283e5#.f9ghb6mzl)
## Contributing
We love community and contributions! Please check out our [guidelines](http://github.com/xogroup/bunnybus/blob/master/.github/CONTRIBUTING.md) before making any PRs.
## Setting up for development
1. Install [Docker](https://docs.docker.com/engine/installation/)
2. Clone this project and `cd` into the project directory
3. Run the commands below
```
npm install
npm run start-docker
npm test
npm run stop-docker
```
For normal development/test iterations, there is no need to stop the docker container. When the docker container is already running, just run `npm test`.