docs: update API reference

weyoss · Jan 9, 2025 · b7d0f6f · b7d0f6f
1 parent c948298
commit b7d0f6f
Show file tree

Hide file tree

Showing 104 changed files with 5,836 additions and 3,165 deletions.
diff --git a/docs/api/README.md b/docs/api/README.md
@@ -6,61 +6,49 @@
 
 ### Enumerations
 
-- [EConsumeMessageDeadLetterCause](enums/EConsumeMessageDeadLetterCause.md)
-- [EConsumeMessageUnacknowledgedCause](enums/EConsumeMessageUnacknowledgedCause.md)
 - [EExchangeType](enums/EExchangeType.md)
 - [EMessagePriority](enums/EMessagePriority.md)
 - [EMessageProperty](enums/EMessageProperty.md)
 - [EMessagePropertyStatus](enums/EMessagePropertyStatus.md)
+- [EMessageUnknowledgmentAction](enums/EMessageUnknowledgmentAction.md)
+- [EMessageUnknowledgmentDeadLetterReason](enums/EMessageUnknowledgmentDeadLetterReason.md)
+- [EMessageUnknowledgmentReason](enums/EMessageUnknowledgmentReason.md)
 - [EQueueDeliveryModel](enums/EQueueDeliveryModel.md)
 - [EQueueProperty](enums/EQueueProperty.md)
 - [EQueueType](enums/EQueueType.md)
 
 ### Classes
 
 - [Configuration](classes/Configuration.md)
-- [Consumer](classes/Consumer.md)
-- [ConsumerGroups](classes/ConsumerGroups.md)
-- [EventBusRedisInstance](classes/EventBusRedisInstance.md)
-- [ExchangeDirect](classes/ExchangeDirect.md)
-- [ExchangeFanOut](classes/ExchangeFanOut.md)
-- [ExchangeTopic](classes/ExchangeTopic.md)
-- [Message](classes/Message.md)
-- [Namespace](classes/Namespace.md)
-- [Producer](classes/Producer.md)
-- [ProducibleMessage](classes/ProducibleMessage.md)
-- [Queue](classes/Queue.md)
-- [QueueAcknowledgedMessages](classes/QueueAcknowledgedMessages.md)
-- [QueueDeadLetteredMessages](classes/QueueDeadLetteredMessages.md)
-- [QueueMessages](classes/QueueMessages.md)
-- [QueuePendingMessages](classes/QueuePendingMessages.md)
-- [QueueRateLimit](classes/QueueRateLimit.md)
-- [QueueScheduledMessages](classes/QueueScheduledMessages.md)
-
-#### Errors
-
 - [ConfigurationError](classes/ConfigurationError.md)
 - [ConfigurationMessageQueueSizeError](classes/ConfigurationMessageQueueSizeError.md)
 - [ConfigurationMessageStoreExpireError](classes/ConfigurationMessageStoreExpireError.md)
 - [ConfigurationNamespaceError](classes/ConfigurationNamespaceError.md)
+- [Consumer](classes/Consumer.md)
 - [ConsumerConsumeMessageHandlerAlreadyExistsError](classes/ConsumerConsumeMessageHandlerAlreadyExistsError.md)
 - [ConsumerConsumerGroupIdNotSupportedError](classes/ConsumerConsumerGroupIdNotSupportedError.md)
 - [ConsumerConsumerGroupIdRequiredError](classes/ConsumerConsumerGroupIdRequiredError.md)
 - [ConsumerError](classes/ConsumerError.md)
+- [ConsumerGroups](classes/ConsumerGroups.md)
 - [ConsumerGroupsConsumerGroupNotEmptyError](classes/ConsumerGroupsConsumerGroupNotEmptyError.md)
 - [ConsumerGroupsConsumerGroupsNotSupportedError](classes/ConsumerGroupsConsumerGroupsNotSupportedError.md)
 - [ConsumerGroupsError](classes/ConsumerGroupsError.md)
 - [ConsumerGroupsInvalidGroupIdError](classes/ConsumerGroupsInvalidGroupIdError.md)
 - [ConsumerGroupsQueueNotFoundError](classes/ConsumerGroupsQueueNotFoundError.md)
 - [EventBusInstanceLockError](classes/EventBusInstanceLockError.md)
+- [EventBusRedisInstance](classes/EventBusRedisInstance.md)
+- [ExchangeDirect](classes/ExchangeDirect.md)
 - [ExchangeError](classes/ExchangeError.md)
+- [ExchangeFanOut](classes/ExchangeFanOut.md)
 - [ExchangeFanOutError](classes/ExchangeFanOutError.md)
 - [ExchangeFanOutExchangeHasBoundQueuesError](classes/ExchangeFanOutExchangeHasBoundQueuesError.md)
 - [ExchangeFanOutQueueTypeError](classes/ExchangeFanOutQueueTypeError.md)
 - [ExchangeInvalidFanOutParamsError](classes/ExchangeInvalidFanOutParamsError.md)
 - [ExchangeInvalidQueueParamsError](classes/ExchangeInvalidQueueParamsError.md)
 - [ExchangeInvalidTopicParamsError](classes/ExchangeInvalidTopicParamsError.md)
 - [ExchangeQueueIsNotBoundToExchangeError](classes/ExchangeQueueIsNotBoundToExchangeError.md)
+- [ExchangeTopic](classes/ExchangeTopic.md)
+- [Message](classes/Message.md)
 - [MessageDestinationQueueAlreadySetError](classes/MessageDestinationQueueAlreadySetError.md)
 - [MessageDestinationQueueRequiredError](classes/MessageDestinationQueueRequiredError.md)
 - [MessageError](classes/MessageError.md)
@@ -71,9 +59,11 @@
 - [MessageMessageNotFoundError](classes/MessageMessageNotFoundError.md)
 - [MessageMessageNotRequeuableError](classes/MessageMessageNotRequeuableError.md)
 - [MessageMessagePropertyError](classes/MessageMessagePropertyError.md)
+- [Namespace](classes/Namespace.md)
 - [NamespaceError](classes/NamespaceError.md)
 - [NamespaceInvalidNamespaceError](classes/NamespaceInvalidNamespaceError.md)
 - [NamespaceNotFoundError](classes/NamespaceNotFoundError.md)
+- [Producer](classes/Producer.md)
 - [ProducerError](classes/ProducerError.md)
 - [ProducerExchangeNoMatchedQueueError](classes/ProducerExchangeNoMatchedQueueError.md)
 - [ProducerInstanceNotRunningError](classes/ProducerInstanceNotRunningError.md)
@@ -84,23 +74,30 @@
 - [ProducerQueueNotFoundError](classes/ProducerQueueNotFoundError.md)
 - [ProducerScheduleInvalidParametersError](classes/ProducerScheduleInvalidParametersError.md)
 - [ProducerUnknownQueueTypeError](classes/ProducerUnknownQueueTypeError.md)
+- [ProducibleMessage](classes/ProducibleMessage.md)
+- [Queue](classes/Queue.md)
+- [QueueAcknowledgedMessages](classes/QueueAcknowledgedMessages.md)
+- [QueueDeadLetteredMessages](classes/QueueDeadLetteredMessages.md)
 - [QueueError](classes/QueueError.md)
 - [QueueInvalidQueueParameterError](classes/QueueInvalidQueueParameterError.md)
+- [QueueMessages](classes/QueueMessages.md)
 - [QueueMessagesConsumerGroupIdNotSupportedError](classes/QueueMessagesConsumerGroupIdNotSupportedError.md)
 - [QueueMessagesConsumerGroupIdRequiredError](classes/QueueMessagesConsumerGroupIdRequiredError.md)
 - [QueueMessagesError](classes/QueueMessagesError.md)
+- [QueuePendingMessages](classes/QueuePendingMessages.md)
 - [QueueQueueExistsError](classes/QueueQueueExistsError.md)
 - [QueueQueueHasRunningConsumersError](classes/QueueQueueHasRunningConsumersError.md)
 - [QueueQueueNotEmptyError](classes/QueueQueueNotEmptyError.md)
 - [QueueQueueNotFoundError](classes/QueueQueueNotFoundError.md)
+- [QueueRateLimit](classes/QueueRateLimit.md)
 - [QueueRateLimitError](classes/QueueRateLimitError.md)
 - [QueueRateLimitInvalidIntervalError](classes/QueueRateLimitInvalidIntervalError.md)
 - [QueueRateLimitInvalidLimitError](classes/QueueRateLimitInvalidLimitError.md)
 - [QueueRateLimitQueueNotFoundError](classes/QueueRateLimitQueueNotFoundError.md)
+- [QueueScheduledMessages](classes/QueueScheduledMessages.md)
 
 ### Interfaces
 
-- [IConsumerConfig](interfaces/IConsumerConfig.md)
 - [IConsumerHeartbeat](interfaces/IConsumerHeartbeat.md)
 - [IConsumerHeartbeatPayload](interfaces/IConsumerHeartbeatPayload.md)
 - [IConsumerMessageHandlerArgs](interfaces/IConsumerMessageHandlerArgs.md)
@@ -119,7 +116,6 @@
 - [IQueueMessages](interfaces/IQueueMessages.md)
 - [IQueueMessagesCount](interfaces/IQueueMessagesCount.md)
 - [IQueueMessagesPage](interfaces/IQueueMessagesPage.md)
-- [IQueueMessagesRequeuable](interfaces/IQueueMessagesRequeuable.md)
 - [IQueueParams](interfaces/IQueueParams.md)
 - [IQueueParsedParams](interfaces/IQueueParsedParams.md)
 - [IQueueProperties](interfaces/IQueueProperties.md)
@@ -130,6 +126,7 @@
 
 ### Type Aliases
 
+- [IConsumerMessageHandlerWorkerPayload](README.md#iconsumermessagehandlerworkerpayload)
 - [IQueueMessagesPageParams](README.md#iqueuemessagespageparams)
 - [TConsumerConsumeMessageEvent](README.md#tconsumerconsumemessageevent)
 - [TConsumerDequeueMessageEvent](README.md#tconsumerdequeuemessageevent)
@@ -139,13 +136,14 @@
 - [TConsumerMessageHandlerEvent](README.md#tconsumermessagehandlerevent)
 - [TConsumerMessageHandlerFn](README.md#tconsumermessagehandlerfn)
 - [TConsumerMessageHandlerRunnerEvent](README.md#tconsumermessagehandlerrunnerevent)
-- [TConsumerRedisKeys](README.md#tconsumerrediskeys)
 - [TEventBusEvent](README.md#teventbusevent)
 - [TExchangeDirectTransferable](README.md#texchangedirecttransferable)
 - [TExchangeFanOutTransferable](README.md#texchangefanouttransferable)
 - [TExchangeTopicTransferable](README.md#texchangetopictransferable)
 - [TExchangeTransferable](README.md#texchangetransferable)
 - [TMessageConsumeOptions](README.md#tmessageconsumeoptions)
+- [TMessageUnacknowledgmentStatus](README.md#tmessageunacknowledgmentstatus)
+- [TMessageUnknowledgmentAction](README.md#tmessageunknowledgmentaction)
 - [TProducerEvent](README.md#tproducerevent)
 - [TQueueConsumer](README.md#tqueueconsumer)
 - [TQueueEvent](README.md#tqueueevent)
@@ -156,6 +154,19 @@
 
 ## Type Aliases
 
+### IConsumerMessageHandlerWorkerPayload
+
+Ƭ **IConsumerMessageHandlerWorkerPayload**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `config` | [`IRedisSMQConfigRequired`](interfaces/IRedisSMQConfigRequired.md) |
+| `queueParsedParams` | [`IQueueParsedParams`](interfaces/IQueueParsedParams.md) |
+
+___
+
 ### IQueueMessagesPageParams
 
 Ƭ **IQueueMessagesPageParams**: `Object`
@@ -181,10 +192,10 @@ ___
 | :------ | :------ |
 | `consumer.consumeMessage.error` | (`err`: `Error`, `consumerId`: `string`, `queue`: [`IQueueParsedParams`](interfaces/IQueueParsedParams.md)) => `void` |
 | `consumer.consumeMessage.messageAcknowledged` | (`messageId`: `string`, `queue`: [`IQueueParsedParams`](interfaces/IQueueParsedParams.md), `messageHandlerId`: `string`, `consumerId`: `string`) => `void` |
-| `consumer.consumeMessage.messageDeadLettered` | (`messageId`: `string`, `queue`: [`IQueueParsedParams`](interfaces/IQueueParsedParams.md), `messageHandlerId`: `string`, `consumerId`: `string`, `cause`: [`EConsumeMessageDeadLetterCause`](enums/EConsumeMessageDeadLetterCause.md)) => `void` |
+| `consumer.consumeMessage.messageDeadLettered` | (`messageId`: `string`, `queue`: [`IQueueParsedParams`](interfaces/IQueueParsedParams.md), `messageHandlerId`: `string`, `consumerId`: `string`, `deadLetterReason`: [`EMessageUnknowledgmentDeadLetterReason`](enums/EMessageUnknowledgmentDeadLetterReason.md)) => `void` |
 | `consumer.consumeMessage.messageDelayed` | (`messageId`: `string`, `queue`: [`IQueueParsedParams`](interfaces/IQueueParsedParams.md), `messageHandlerId`: `string`, `consumerId`: `string`) => `void` |
 | `consumer.consumeMessage.messageRequeued` | (`messageId`: `string`, `queue`: [`IQueueParsedParams`](interfaces/IQueueParsedParams.md), `messageHandlerId`: `string`, `consumerId`: `string`) => `void` |
-| `consumer.consumeMessage.messageUnacknowledged` | (`messageId`: `string`, `queue`: [`IQueueParsedParams`](interfaces/IQueueParsedParams.md), `messageHandlerId`: `string`, `consumerId`: `string`, `cause`: [`EConsumeMessageUnacknowledgedCause`](enums/EConsumeMessageUnacknowledgedCause.md)) => `void` |
+| `consumer.consumeMessage.messageUnacknowledged` | (`messageId`: `string`, `queue`: [`IQueueParsedParams`](interfaces/IQueueParsedParams.md), `messageHandlerId`: `string`, `consumerId`: `string`, `unknowledgmentReason`: [`EMessageUnknowledgmentReason`](enums/EMessageUnknowledgmentReason.md)) => `void` |
 
 ___
 
@@ -282,12 +293,6 @@ ___
 
 ___
 
-### TConsumerRedisKeys
-
-Ƭ **TConsumerRedisKeys**: `ReturnType`\<typeof `redisKeys`[``"getConsumerKeys"``]\>
-
-___
-
 ### TEventBusEvent
 
 Ƭ **TEventBusEvent**: `Object`
@@ -363,6 +368,18 @@ ___
 
 ___
 
+### TMessageUnacknowledgmentStatus
+
+Ƭ **TMessageUnacknowledgmentStatus**: `Record`\<`string`, [`TMessageUnknowledgmentAction`](README.md#tmessageunknowledgmentaction)\>
+
+___
+
+### TMessageUnknowledgmentAction
+
+Ƭ **TMessageUnknowledgmentAction**: \{ `action`: [`REQUEUE`](enums/EMessageUnknowledgmentAction.md#requeue) \| [`DELAY`](enums/EMessageUnknowledgmentAction.md#delay)  } \| \{ `action`: [`DEAD_LETTER`](enums/EMessageUnknowledgmentAction.md#dead_letter) ; `deadLetterReason`: [`EMessageUnknowledgmentDeadLetterReason`](enums/EMessageUnknowledgmentDeadLetterReason.md)  }
+
+___
+
 ### TProducerEvent
 
 Ƭ **TProducerEvent**: `Object`

diff --git a/docs/api/classes/Configuration.md b/docs/api/classes/Configuration.md
@@ -24,7 +24,7 @@ ___
 
 ### getSetConfig
 
-▸ **getSetConfig**(`config?`): [`IRedisSMQConfigRequired`](../interfaces/IRedisSMQConfigRequired.md)
+▸ `Static` **getSetConfig**(`config?`): [`IRedisSMQConfigRequired`](../interfaces/IRedisSMQConfigRequired.md)
 
 #### Parameters
 
@@ -40,7 +40,7 @@ ___
 
 ### reset
 
-▸ **reset**(): `void`
+▸ `Static` **reset**(): `void`
 
 #### Returns
 

diff --git a/docs/api/classes/ConfigurationError.md b/docs/api/classes/ConfigurationError.md
@@ -20,22 +20,142 @@
 
 - [constructor](ConfigurationError.md#constructor)
 
+### Properties
+
+- [cause](ConfigurationError.md#cause)
+- [message](ConfigurationError.md#message)
+- [stack](ConfigurationError.md#stack)
+- [prepareStackTrace](ConfigurationError.md#preparestacktrace)
+- [stackTraceLimit](ConfigurationError.md#stacktracelimit)
+
+### Accessors
+
+- [name](ConfigurationError.md#name)
+
+### Methods
+
+- [captureStackTrace](ConfigurationError.md#capturestacktrace)
+
 ## Constructors
 
 ### constructor
 
-• **new ConfigurationError**(`message?`): [`ConfigurationError`](ConfigurationError.md)
+• **new ConfigurationError**(`message?`)
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `message?` | `string` |
 
+#### Inherited from
+
+RedisSMQError.constructor
+
+## Properties
+
+### cause
+
+• `Optional` **cause**: `unknown`
+
+#### Inherited from
+
+RedisSMQError.cause
+
+___
+
+### 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
 
-[`ConfigurationError`](ConfigurationError.md)
+`string`
 
 #### Inherited from
 
-RedisSMQError.constructor
+RedisSMQError.name
+
+## Methods
+
+### captureStackTrace
+
+▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+RedisSMQError.captureStackTrace