docs: update documentation

weyoss · Dec 11, 2023 · 85d6adb · 85d6adb
1 parent 20fd6e5
commit 85d6adb
Show file tree

Hide file tree

Showing 12 changed files with 16 additions and 16 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,4 +1,4 @@
->[RedisSMQ](../README.md) / Docs
+[RedisSMQ](../README.md) / Docs
 
 # RedisSMQ Docs
 

diff --git a/docs/api/classes/MessageEnvelope.md b/docs/api/classes/MessageEnvelope.md
@@ -178,11 +178,11 @@ ___
 
 ### getPriority
 
-▸ **getPriority**(): ``null`` \| `number`
+▸ **getPriority**(): ``null`` \| [`EMessagePriority`](../enums/EMessagePriority.md)
 
 #### Returns
 
-``null`` \| `number`
+``null`` \| [`EMessagePriority`](../enums/EMessagePriority.md)
 
 ___
 
@@ -510,7 +510,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `priority` | `number` |
+| `priority` | [`EMessagePriority`](../enums/EMessagePriority.md) |
 
 #### Returns
 

diff --git a/docs/consuming-messages.md b/docs/consuming-messages.md
@@ -1,4 +1,4 @@
->[RedisSMQ](../README.md) / [Docs](README.md) / Consuming Messages
+[RedisSMQ](../README.md) / [Docs](README.md) / Consuming Messages
 
 # Consuming Messages
 

diff --git a/docs/message-exchanges.md b/docs/message-exchanges.md
@@ -1,4 +1,4 @@
->[RedisSMQ](../README.md) / [Docs](README.md) / Message Exchanges
+[RedisSMQ](../README.md) / [Docs](README.md) / Message Exchanges
 
 # Message Exchanges
 

diff --git a/docs/messages.md b/docs/messages.md
@@ -1,4 +1,4 @@
->[RedisSMQ](../README.md) / [Docs](README.md) / Messages
+[RedisSMQ](../README.md) / [Docs](README.md) / Messages
 
 # Messages
 
@@ -17,4 +17,4 @@ msg.setBody({hello: 'world'})
 
 The `MessageEnvelope` class provides many methods for setting up different delivery/consumption parameters such as message priority, message TTL, retry threshold, etc.
 
-See [MessageEnvelope Class](api/classes/MessageEnvelope.md) for more details.
+See [Message Class](api/classes/Message.md) and [MessageEnvelope Class](api/classes/MessageEnvelope.md) for more details.
diff --git a/docs/multiplexing.md b/docs/multiplexing.md
@@ -1,4 +1,4 @@
->[RedisSMQ](../README.md) / [Docs](README.md) / Multiplexing
+[RedisSMQ](../README.md) / [Docs](README.md) / Multiplexing
 
 # Multiplexing
 
@@ -20,7 +20,7 @@ So, before deciding whether to use multiplexing, it is important to know what yo
 
 ## Enabling multiplexing
 
-Use the [Consumer class constructor](api/classes/Consumer.md#constructors) first argument to enable multiplexing:
+Use the [Consumer class constructor](api/classes/Consumer.md#constructor) first argument to enable multiplexing:
 
 ```javascript
 const consumer = new Consumer(true);

diff --git a/docs/performance.md b/docs/performance.md
@@ -1,4 +1,4 @@
->[RedisSMQ](../README.md) / [Docs](README.md) / Performance
+[RedisSMQ](../README.md) / [Docs](README.md) / Performance
 
 
 # Performance

diff --git a/docs/producing-messages.md b/docs/producing-messages.md
@@ -1,4 +1,4 @@
->[RedisSMQ](../README.md) / [Docs](README.md) / Producing Messages
+[RedisSMQ](../README.md) / [Docs](README.md) / Producing Messages
 
 # Producing Messages
 

diff --git a/docs/queue-rate-limiting.md b/docs/queue-rate-limiting.md
@@ -1,4 +1,4 @@
->[RedisSMQ](../README.md) / [Docs](README.md) / Queue Rate limiting
+[RedisSMQ](../README.md) / [Docs](README.md) / Queue Rate limiting
 
 # Queue Rate limiting
 

diff --git a/docs/queues.md b/docs/queues.md
@@ -1,4 +1,4 @@
->[RedisSMQ](../README.md) / [Docs](README.md) / Queues
+[RedisSMQ](../README.md) / [Docs](README.md) / Queues
 
 # Queues
 

diff --git a/docs/redis-smq-architecture.md b/docs/redis-smq-architecture.md
@@ -1,4 +1,4 @@
->[RedisSMQ](../README.md) / [Docs](README.md) / RedisSMQ Architecture Overview
+[RedisSMQ](../README.md) / [Docs](README.md) / RedisSMQ Architecture Overview
 
 # RedisSMQ Architecture Overview
 

diff --git a/docs/scheduling-messages.md b/docs/scheduling-messages.md
@@ -1,4 +1,4 @@
->[RedisSMQ](../README.md) / [Docs](README.md) / Scheduling Messages
+[RedisSMQ](../README.md) / [Docs](README.md) / Scheduling Messages
 
 # Scheduling Messages