redis-smq 7.0.0-rc.4 → 7.0.0-rc.5

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 7.0.0-rc.5 (2022-05-31)
+
+* Bump up redis-smq-common to v1.0.0-rc.10 (e025525)
+* Update docs (738d9d0)
+
 ## 7.0.0-rc.4 (2022-05-30)
 
 * Update README.md (fef27c1)

package/README.md

@@ -19,19 +19,19 @@ RedisSMQ is a Node.js library for queuing messages (aka jobs) and processing the
 
 ## Features
 
-* **[High-performance message processing](docs/performance.md)**
+* **[High-performance message processing](/docs/performance.md)**
 * **[Multi-Queue Producers](#producer-class) & [Multi-Queue Consumers](#consumer-class)**: Offering very flexible models which make RedisSMQ an ideal message broker for your microservices. 
 * **[Supporting both at-least-once/at-most-once delivery](/docs/api/message.md#messageprototypesetretrythreshold)**: In case of failures, while delivering or processing a message, RedisSMQ can guaranty that the message will be not lost and redelivered again. When configured to do so, RedisSMQ can also ensure that the message is delivered at-most-once.
-* **[Message Expiration](docs/api/message.md#messageprototypesetttl)**: A message will not be delivered if it has been in a queue for longer than a given amount of time, called TTL (time-to-live).
-* **[Message Consumption Timeout](docs/api/message.md#messageprototypesetconsumetimeout)**: Timeout for consuming messages.
-* **[Queue Rate Limiting](docs/queue-rate-limiting.md)**: Allowing you to control the rate at which the messages are consumed from a given queue.
-* **[Scheduling Messages](docs/scheduling-messages.md)**: Messages can be configured to be delayed, delivered for N times with an optional period between deliveries, and to be scheduled using CRON expressions.
-* **[Reliable Priority Queues](docs/priority-queues.md)**: Supports priority messaging.
-* **[Multiplexing](docs/multiplexing.md)**: A feature which allows message handlers to use a single redis connection to dequeue and consume messages.  
+* **[Message Expiration](/docs/api/message.md#messageprototypesetttl)**: A message will not be delivered if it has been in a queue for longer than a given amount of time, called TTL (time-to-live).
+* **[Message Consumption Timeout](/docs/api/message.md#messageprototypesetconsumetimeout)**: Timeout for consuming messages.
+* **[Queue Rate Limiting](/docs/queue-rate-limiting.md)**: Allowing you to control the rate at which the messages are consumed from a given queue.
+* **[Scheduling Messages](/docs/scheduling-messages.md)**: Messages can be configured to be delayed, delivered for N times with an optional period between deliveries, and to be scheduled using CRON expressions.
+* **[Reliable Priority Queues](/docs/priority-queues.md)**: Supports priority messaging.
+* **[Multiplexing](/docs/multiplexing.md)**: A feature which allows message handlers to use a single redis connection to dequeue and consume messages.  
 * **[HTTP API](https://github.com/weyoss/redis-smq-monitor)**: an HTTP interface is provided to interact with the MQ.
 * **[Web UI](https://github.com/weyoss/redis-smq-monitor-client)**: RedisSMQ can be managed also from your web browser.
 * **[Logging](https://github.com/weyoss/redis-smq-common/blob/master/docs/logs.md)**: Comes with a built-in JSON logger. But you can also use your own logger instance.
-* **[Configurable](docs/configuration.md)**: Many options and features can be configured.
+* **[Configurable](/docs/configuration.md)**: Many options and features can be configured.
 * **Both redis & ioredis clients are supported**: RedisSMQ can be configured to use either `redis` or `ioredis` to connect to Redis server.
 * **Rigorously tested**: With 100+ tests and code coverage no less than 80%.
 * **Highly optimized**: Strongly-typed and implemented using pure callbacks, with small memory footprint and no memory leaks. See [callbacks vs promises vs async/await benchmarks](http://bluebirdjs.com/docs/benchmarks.html).
@@ -41,7 +41,7 @@ RedisSMQ is a Node.js library for queuing messages (aka jobs) and processing the
 
  
 
-![RedisSMQ Overview](docs/redis-smq-overview.png)
+![RedisSMQ Overview](/docs/redis-smq-overview.png)
 
 ## Table of Content
 
@@ -54,16 +54,16 @@ RedisSMQ is a Node.js library for queuing messages (aka jobs) and processing the
        2. [Producer Class](#producer-class)
        3. [Consumer Class](#consumer-class)
    2. Advanced Topics
-      1. [Scheduling Messages](docs/scheduling-messages.md)
-      2. [Priority Queues](docs/priority-queues.md)
-      3. [Queue Rate Limiting](docs/queue-rate-limiting.md)
-      4. [Multiplexing](docs/multiplexing.md)
-      5. [Message Manager](docs/api/message-manager.md)
-      6. [Queue Manager](docs/api/queue-manager.md)
+      1. [Scheduling Messages](/docs/scheduling-messages.md)
+      2. [Priority Queues](/docs/priority-queues.md)
+      3. [Queue Rate Limiting](/docs/queue-rate-limiting.md)
+      4. [Multiplexing](/docs/multiplexing.md)
+      5. [Message Manager](/docs/api/message-manager.md)
+      6. [Queue Manager](/docs/api/queue-manager.md)
       7. [HTTP API](https://github.com/weyoss/redis-smq-monitor)
       8. [Web UI](https://github.com/weyoss/redis-smq-monitor-client)
       9. [Logs](https://github.com/weyoss/redis-smq-common/blob/master/docs/logs.md)
-5. [RedisSMQ Architecture](docs/redis-smq-architecture.md)
+5. [RedisSMQ Architecture](/docs/redis-smq-architecture.md)
 6. [Performance](#performance)
 7. [Contributing](#contributing)
 8. [License](#license)
@@ -88,7 +88,7 @@ Considerations:
 
 ## Configuration
 
-See [Configuration](docs/configuration.md) for more details.
+See [Configuration](/docs/configuration.md) for more details.
 
 ## Usage
 
@@ -129,7 +129,7 @@ message
 
 The `Message` class provides many methods for setting up different message parameters such as message body, message priority, message TTL, etc. 
 
-See [Message Reference](docs/api/message.md) for more details.
+See [Message Reference](/docs/api/message.md) for more details.
 
 #### Producer Class
 
@@ -162,7 +162,7 @@ producer.produce(message, (err) => {
 });
 ```
 
-See [Producer Reference](docs/api/producer.md) for more details.
+See [Producer Reference](/docs/api/producer.md) for more details.
 
 #### Consumer Class
 
@@ -214,21 +214,21 @@ A `dead-letter queue` is a system generated queue that holds all messages that c
 
 By default, RedisSMQ does not store acknowledged and dead-lettered messages for saving disk and memory space, and also to increase message processing performance. If you need such feature, you can enable it from your [configuration](/docs/configuration.md) object.
 
-See [Consumer Reference](docs/api/consumer.md) for more details.
+See [Consumer Reference](/docs/api/consumer.md) for more details.
 
 ### Advanced Topics
 
-* [Scheduling Messages](docs/scheduling-messages.md)
+* [Scheduling Messages](/docs/scheduling-messages.md)
 
-* [Priority Queues](docs/priority-queues.md)
+* [Priority Queues](/docs/priority-queues.md)
 
-* [Queue Rate Limiting](docs/queue-rate-limiting.md)
+* [Queue Rate Limiting](/docs/queue-rate-limiting.md)
 
-* [Multiplexing](docs/multiplexing.md)
+* [Multiplexing](/docs/multiplexing.md)
   
-* [Message Manager](docs/api/message-manager.md)
+* [Message Manager](/docs/api/message-manager.md)
 
-* [Queue Manager](docs/api/queue-manager.md)
+* [Queue Manager](/docs/api/queue-manager.md)
 
 * [HTTP API](https://github.com/weyoss/redis-smq-monitor)
 
@@ -238,11 +238,11 @@ See [Consumer Reference](docs/api/consumer.md) for more details.
 
 ## RedisSMQ Architecture
 
-* See [Architecture Overview](docs/redis-smq-architecture.md).
+* See [Architecture Overview](/docs/redis-smq-architecture.md).
 
 ## Performance
 
-See [Performance](docs/performance.md) for more details.
+See [Performance](/docs/performance.md) for more details.
 
 ## Contributing
 

package/dist/src/lib/consumer/consumer-message-handler/dequeue-message.d.ts

@@ -14,8 +14,8 @@ export declare class DequeueMessage {
     protected priorityQueuing: boolean;
     constructor(messageHandler: MessageHandler, redisClient: RedisClient);
     protected dequeueMessageWithPriority(cb: ICallback<string>): void;
-    protected waitForMessage(cb: ICallback<string>): void;
-    protected dequeueMessage(cb: ICallback<string>): void;
+    protected waitForMessage(cb: ICallback<string | null>): void;
+    protected dequeueMessage(cb: ICallback<string | null>): void;
     dequeue(): void;
     run(cb: ICallback<void>): void;
     quit(cb: ICallback<void>): void;

package/dist/src/lib/queue-manager/queue-rate-limit.d.ts

@@ -8,7 +8,7 @@ export declare class QueueRateLimit {
     constructor(config: IRequiredConfig, redisClient: RedisClient, logger: ICompatibleLogger);
     clear(queue: string | TQueueParams, cb: ICallback<void>): void;
     set(queue: string | TQueueParams, rateLimit: TQueueRateLimit, cb: ICallback<void>): void;
-    get(queue: string | TQueueParams, cb: ICallback<TQueueRateLimit>): void;
+    get(queue: string | TQueueParams, cb: ICallback<TQueueRateLimit | null>): void;
     static hasExceeded(redisClient: RedisClient, queue: TQueueParams, rateLimit: TQueueRateLimit, cb: ICallback<boolean>): void;
-    static get(config: IRequiredConfig, redisClient: RedisClient, queue: string | TQueueParams, cb: ICallback<TQueueRateLimit>): void;
+    static get(config: IRequiredConfig, redisClient: RedisClient, queue: string | TQueueParams, cb: ICallback<TQueueRateLimit | null>): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis-smq",
-  "version": "7.0.0-rc.4",
+  "version": "7.0.0-rc.5",
   "description": "A simple high-performance Redis message queue for Node.js.",
   "author": "Weyoss <weyoss@protonmail.com>",
   "license": "MIT",
@@ -36,7 +36,7 @@
     "bluebird": "3.7.2",
     "cron-parser": "3.5.0",
     "lodash": "4.17.21",
-    "redis-smq-common": "1.0.0-rc.8",
+    "redis-smq-common": "1.0.0-rc.10",
     "uuid": "8.3.2"
   },
   "devDependencies": {