docs: add missing error classes reference, clean up

weyoss · Nov 20, 2023 · 106b6d0 · 106b6d0
1 parent 30a6099
commit 106b6d0
Show file tree

Hide file tree

Showing 101 changed files with 3,665 additions and 78 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
 
@@ -15,7 +15,7 @@
 - [Scheduling Messages](scheduling-messages.md)
 - [Performance](performance.md)
 - [RedisSMQ Architecture](redis-smq-architecture.md)
-- [Logs](https://github.com/weyoss/redis-smq-common/blob/master/docs/logs.md)
+- [Logs](https://github.com/weyoss/redis-smq-common/blob/master/docs/README.md#logs)
 - Extra
   - [HTTP API](https://github.com/weyoss/redis-smq-monitor)
   - [Web UI](https://github.com/weyoss/redis-smq-monitor-client)
diff --git a/docs/api/README.md b/docs/api/README.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../README.md) / [Docs](../README.md) / API Reference
+>[RedisSMQ](../../README.md) / [Docs](../README.md) / API Reference
 
 # RedisSMQ API Reference
 
@@ -22,6 +22,33 @@
 - [QueueRateLimit](classes/QueueRateLimit.md)
 - [QueueScheduledMessages](classes/QueueScheduledMessages.md)
 
+### Errors
+
+- [ConsumerError](errors/ConsumerError.md)
+- [ConsumerMessageHandlerAlreadyExistsError](errors/ConsumerMessageHandlerAlreadyExistsError.md)
+- [ExchangeError](errors/ExchangeError.md)
+- [ExchangeFanOutError](errors/ExchangeFanOutError.md)
+- [ExchangeInvalidDataError](errors/ExchangeInvalidDataError.md)
+- [MessageDestinationQueueAlreadySetError](errors/MessageDestinationQueueAlreadySetError.md)
+- [MessageDestinationQueueRequiredError](errors/MessageDestinationQueueRequiredError.md)
+- [MessageError](errors/MessageError.md)
+- [MessageExchangeRequiredError](errors/MessageExchangeRequiredError.md)
+- [ProducerError](errors/ProducerError.md)
+- [ProducerInstanceNotRunningError](errors/ProducerInstanceNotRunningError.md)
+- [ProducerMessageAlreadyPublishedError](errors/ProducerMessageAlreadyPublishedError.md)
+- [ProducerMessageNotPublishedError](errors/ProducerMessageNotPublishedError.md)
+- [ProducerMessageNotScheduledError](errors/ProducerMessageNotScheduledError.md)
+- [QueueDeleteOperationError](errors/QueueDeleteOperationError.md)
+- [QueueError](errors/QueueError.md)
+- [QueueExistsError](errors/QueueExistsError.md)
+- [QueueHasRunningConsumersError](errors/QueueHasRunningConsumersError.md)
+- [QueueMessageNotFoundError](errors/QueueMessageNotFoundError.md)
+- [QueueMessageRequeueError](errors/QueueMessageRequeueError.md)
+- [QueueNamespaceNotFoundError](errors/QueueNamespaceNotFoundError.md)
+- [QueueNotEmptyError](errors/QueueNotEmptyError.md)
+- [QueueNotFoundError](errors/QueueNotFoundError.md)
+- [QueueRateLimitError](errors/QueueRateLimitError.md)
+
 ### Functions
 
 - [disconnect](functions/disconnect.md)

diff --git a/docs/api/classes/Configuration.md b/docs/api/classes/Configuration.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / Configuration
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / Configuration
 
 # Class: Configuration
 

diff --git a/docs/api/classes/Consumer.md b/docs/api/classes/Consumer.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / Consumer
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / Consumer
 
 # Class: Consumer
 

diff --git a/docs/api/classes/ExchangeDirect.md b/docs/api/classes/ExchangeDirect.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / ExchangeDirect
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / ExchangeDirect
 
 # Class: ExchangeDirect
 

diff --git a/docs/api/classes/ExchangeFanOut.md b/docs/api/classes/ExchangeFanOut.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / ExchangeFanOut
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / ExchangeFanOut
 
 # Class: ExchangeFanOut
 

diff --git a/docs/api/classes/ExchangeTopic.md b/docs/api/classes/ExchangeTopic.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / ExchangeTopic
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / ExchangeTopic
 
 # Class: ExchangeTopic
 

diff --git a/docs/api/classes/Message.md b/docs/api/classes/Message.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / Message
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / Message
 
 # Class: Message
 

diff --git a/docs/api/classes/Namespace.md b/docs/api/classes/Namespace.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / Namespace
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / Namespace
 
 # Class: Namespace
 

diff --git a/docs/api/classes/Producer.md b/docs/api/classes/Producer.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / Producer
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / Producer
 
 # Class: Producer
 

diff --git a/docs/api/classes/Queue.md b/docs/api/classes/Queue.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / Queue
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / Queue
 
 # Class: Queue
 

diff --git a/docs/api/classes/QueueAcknowledgedMessages.md b/docs/api/classes/QueueAcknowledgedMessages.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / QueueAcknowledgedMessages
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / QueueAcknowledgedMessages
 
 # Class: QueueAcknowledgedMessages
 

diff --git a/docs/api/classes/QueueDeadLetteredMessages.md b/docs/api/classes/QueueDeadLetteredMessages.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / QueueDeadLetteredMessages
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / QueueDeadLetteredMessages
 
 # Class: QueueDeadLetteredMessages
 

diff --git a/docs/api/classes/QueueMessages.md b/docs/api/classes/QueueMessages.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / QueueMessages
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / QueueMessages
 
 # Class: QueueMessages
 

diff --git a/docs/api/classes/QueuePendingMessages.md b/docs/api/classes/QueuePendingMessages.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / QueuePendingMessages
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / QueuePendingMessages
 
 # Class: QueuePendingMessages
 

diff --git a/docs/api/classes/QueueRateLimit.md b/docs/api/classes/QueueRateLimit.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / QueueRateLimit
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / QueueRateLimit
 
 # Class: QueueRateLimit
 

diff --git a/docs/api/classes/QueueScheduledMessages.md b/docs/api/classes/QueueScheduledMessages.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / QueueScheduledMessages
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / QueueScheduledMessages
 
 # Class: QueueScheduledMessages
 

diff --git a/docs/api/enumerations/EConsumeMessageDeadLetterCause.md b/docs/api/enumerations/EConsumeMessageDeadLetterCause.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / EConsumeMessageDeadLetterCause
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / EConsumeMessageDeadLetterCause
 
 # Enumeration: EConsumeMessageDeadLetterCause
 

diff --git a/docs/api/enumerations/EConsumeMessageUnacknowledgedCause.md b/docs/api/enumerations/EConsumeMessageUnacknowledgedCause.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / EConsumeMessageUnacknowledgedCause
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / EConsumeMessageUnacknowledgedCause
 
 # Enumeration: EConsumeMessageUnacknowledgedCause
 

diff --git a/docs/api/enumerations/EExchangeType.md b/docs/api/enumerations/EExchangeType.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / EExchangeType
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / EExchangeType
 
 # Enumeration: EExchangeType
 

diff --git a/docs/api/enumerations/EMessageProperty.md b/docs/api/enumerations/EMessageProperty.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / EMessageProperty
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / EMessageProperty
 
 # Enumeration: EMessageProperty
 

diff --git a/docs/api/enumerations/EMessagePropertyStatus.md b/docs/api/enumerations/EMessagePropertyStatus.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / EMessagePropertyStatus
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / EMessagePropertyStatus
 
 # Enumeration: EMessagePropertyStatus
 

diff --git a/docs/api/enumerations/EQueueProperty.md b/docs/api/enumerations/EQueueProperty.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / EQueueProperty
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / EQueueProperty
 
 # Enumeration: EQueueProperty
 

diff --git a/docs/api/enumerations/EQueueType.md b/docs/api/enumerations/EQueueType.md
@@ -1,4 +1,4 @@
-[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / EQueueType
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / EQueueType
 
 # Enumeration: EQueueType
 

diff --git a/docs/api/errors/ConsumerError.md b/docs/api/errors/ConsumerError.md
@@ -0,0 +1,150 @@
+>[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / ConsumerError
+
+# Class: ConsumerError
+
+## Hierarchy
+
+- `RedisSMQError`
+
+  ↳ **`ConsumerError`**
+
+  ↳↳ [`ConsumerMessageHandlerAlreadyExistsError`](ConsumerMessageHandlerAlreadyExistsError.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ConsumerError.md#constructor)
+
+### Properties
+
+- [message](ConsumerError.md#message)
+- [stack](ConsumerError.md#stack)
+- [prepareStackTrace](ConsumerError.md#preparestacktrace)
+- [stackTraceLimit](ConsumerError.md#stacktracelimit)
+
+### Accessors
+
+- [name](ConsumerError.md#name)
+
+### Methods
+
+- [captureStackTrace](ConsumerError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new ConsumerError**(`message?`): [`ConsumerError`](ConsumerError.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message?` | `string` |
+
+#### Returns
+
+[`ConsumerError`](ConsumerError.md)
+
+#### Inherited from
+
+RedisSMQError.constructor
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+RedisSMQError.message
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+RedisSMQError.stack
+
+___
+
+### prepareStackTrace
+
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+▸ (`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+**`See`**
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+RedisSMQError.prepareStackTrace
+
+___
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+RedisSMQError.stackTraceLimit
+
+## Accessors
+
+### name
+
+• `get` **name**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+RedisSMQError.name
+
+## Methods
+
+### captureStackTrace
+
+▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+RedisSMQError.captureStackTrace