Comparing version 1.1.0 to 1.1.1
# Changelog | ||
### [1.1.1](https://www.github.com/AlbertHernandez/bull-bus/compare/v1.1.0...v1.1.1) (2022-01-22) | ||
### Bug Fixes | ||
* improve readme and links ([1834166](https://www.github.com/AlbertHernandez/bull-bus/commit/18341664d088b66bc8cb78d46d22cbbfb3b5b817)) | ||
## [1.1.0](https://www.github.com/AlbertHernandez/bull-bus/compare/v1.0.1...v1.1.0) (2022-01-22) | ||
@@ -4,0 +11,0 @@ |
{ | ||
"name": "bull-bus", | ||
"version": "1.1.0", | ||
"version": "1.1.1", | ||
"description": "Event Bus for Node.JS using Bull Queues", | ||
@@ -5,0 +5,0 @@ "main": "src/index.js", |
@@ -10,3 +10,3 @@ <h1 align="center">🚀</h1> | ||
<p align="center"> | ||
Event Bus for Node.JS using Bull Queues | ||
Event Bus for Node.JS using <a href="https://github.com/OptimalBits/bull">Bull</a> Queues | ||
</p> | ||
@@ -17,3 +17,7 @@ | ||
* [Installation](#installation) | ||
* [How it works](#how-it-works) | ||
* [How to Use It](#how-to-use-it) | ||
* [Bull Bus](#bull-bus) | ||
* [Bull Event Bus](#bull-event-bus) | ||
* [Visualization](#visualization) | ||
* [Playground](#playground) | ||
@@ -32,2 +36,10 @@ * [Preparing environment to contribute](#preparing-environment) | ||
## How it works | ||
When we work with event buses we normally have 1 event that can be consumed by N subscribers. When we want to create a new subscriber we will need to provide 3 main things: | ||
* `Topic Name`: will be used to know the subscriptions that should be executed when a new topic is published. | ||
* `Subscriber Name`: we can have N subscribers to a topic. The pair (topicName, subscriberName) will identify a unique subscription. Check how this is useful to [visualize](#visualization) the queues. | ||
* `Handler`: this is the function that will be executed when a message is published to a particular topic. | ||
## How to Use It | ||
@@ -171,3 +183,3 @@ | ||
When we are working with event bus, we normally have 1 event that can be consumed by N subscribers. When we are building the subscribers we need to provide topicName and subscriptionName, in this way when the buses are getting the queue instance will use both attributes as unique identifier. In this way, if we use some Bull UI like taskforce, will show all the subscriptions we have for every topic. | ||
Both buses are ready to show the internal queues to display the job data in a pretty way. The following image is using <a href="https://taskforce.sh/">Taskforce</a>, but can be used any UI for Bull. | ||
@@ -174,0 +186,0 @@ <a href="https://github.com/AlbertHernandez/insomnia-plugin-ocean-light-theme"> |
463785
239