docs(QueueMessages): remove redundant method deleteMessage()

weyoss · Dec 9, 2023 · cdeb454 · cdeb454
1 parent dfa3792
commit cdeb454
Show file tree

Hide file tree

Showing 7 changed files with 2 additions and 139 deletions.
diff --git a/docs/api/classes/QueueAcknowledgedMessages.md b/docs/api/classes/QueueAcknowledgedMessages.md
@@ -17,7 +17,6 @@
 ### Methods
 
 - [countMessages](QueueAcknowledgedMessages.md#countmessages)
-- [deleteMessage](QueueAcknowledgedMessages.md#deletemessage)
 - [getMessages](QueueAcknowledgedMessages.md#getmessages)
 - [purge](QueueAcknowledgedMessages.md#purge)
 - [requeueMessage](QueueAcknowledgedMessages.md#requeuemessage)
@@ -59,28 +58,6 @@ QueueMessagesPaginatorList.countMessages
 
 ___
 
-### deleteMessage
-
-▸ **deleteMessage**(`queue`, `messageId`, `cb`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `queue` | `string` \| [`IQueueParams`](../interfaces/IQueueParams.md) |
-| `messageId` | `string` \| `string`[] |
-| `cb` | `ICallback`\<`void`\> |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-QueueMessagesPaginatorList.deleteMessage
-
-___
-
 ### getMessages
 
 ▸ **getMessages**(`queue`, `cursor`, `pageSize`, `cb`): `void`

diff --git a/docs/api/classes/QueueDeadLetteredMessages.md b/docs/api/classes/QueueDeadLetteredMessages.md
@@ -17,7 +17,6 @@
 ### Methods
 
 - [countMessages](QueueDeadLetteredMessages.md#countmessages)
-- [deleteMessage](QueueDeadLetteredMessages.md#deletemessage)
 - [getMessages](QueueDeadLetteredMessages.md#getmessages)
 - [purge](QueueDeadLetteredMessages.md#purge)
 - [requeueMessage](QueueDeadLetteredMessages.md#requeuemessage)
@@ -59,28 +58,6 @@ QueueMessagesPaginatorList.countMessages
 
 ___
 
-### deleteMessage
-
-▸ **deleteMessage**(`queue`, `messageId`, `cb`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `queue` | `string` \| [`IQueueParams`](../interfaces/IQueueParams.md) |
-| `messageId` | `string` \| `string`[] |
-| `cb` | `ICallback`\<`void`\> |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-QueueMessagesPaginatorList.deleteMessage
-
-___
-
 ### getMessages
 
 ▸ **getMessages**(`queue`, `cursor`, `pageSize`, `cb`): `void`

diff --git a/docs/api/classes/QueueMessages.md b/docs/api/classes/QueueMessages.md
@@ -18,7 +18,6 @@
 
 - [countMessages](QueueMessages.md#countmessages)
 - [countMessagesByStatus](QueueMessages.md#countmessagesbystatus)
-- [deleteMessage](QueueMessages.md#deletemessage)
 - [deleteMessageById](QueueMessages.md#deletemessagebyid)
 - [deleteMessagesByIds](QueueMessages.md#deletemessagesbyids)
 - [getMessageById](QueueMessages.md#getmessagebyid)
@@ -80,28 +79,6 @@ ___
 
 ___
 
-### deleteMessage
-
-▸ **deleteMessage**(`queue`, `messageId`, `cb`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `queue` | `string` \| [`IQueueParams`](../interfaces/IQueueParams.md) |
-| `messageId` | `string` \| `string`[] |
-| `cb` | `ICallback`\<`void`\> |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-QueueMessagesPaginatorSet.deleteMessage
-
-___
-
 ### deleteMessageById
 
 ▸ **deleteMessageById**(`id`, `cb`): `void`

diff --git a/docs/api/classes/QueuePendingMessages.md b/docs/api/classes/QueuePendingMessages.md
@@ -15,7 +15,6 @@
 ### Methods
 
 - [countMessages](QueuePendingMessages.md#countmessages)
-- [deleteMessage](QueuePendingMessages.md#deletemessage)
 - [getMessages](QueuePendingMessages.md#getmessages)
 - [purge](QueuePendingMessages.md#purge)
 
@@ -52,28 +51,6 @@
 
 ___
 
-### deleteMessage
-
-▸ **deleteMessage**(`queue`, `messageId`, `cb`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `queue` | `string` \| [`IQueueParams`](../interfaces/IQueueParams.md) |
-| `messageId` | `string` |
-| `cb` | `ICallback`\<`void`\> |
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-[IQueueMessages](../interfaces/IQueueMessages.md).[deleteMessage](../interfaces/IQueueMessages.md#deletemessage)
-
-___
-
 ### getMessages
 
 ▸ **getMessages**(`queue`, `cursor`, `pageSize`, `cb`): `void`

diff --git a/docs/api/classes/QueueScheduledMessages.md b/docs/api/classes/QueueScheduledMessages.md
@@ -17,7 +17,6 @@
 ### Methods
 
 - [countMessages](QueueScheduledMessages.md#countmessages)
-- [deleteMessage](QueueScheduledMessages.md#deletemessage)
 - [getMessages](QueueScheduledMessages.md#getmessages)
 - [purge](QueueScheduledMessages.md#purge)
 
@@ -58,28 +57,6 @@ QueueMessagesPaginatorSortedSet.countMessages
 
 ___
 
-### deleteMessage
-
-▸ **deleteMessage**(`queue`, `messageId`, `cb`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `queue` | `string` \| [`IQueueParams`](../interfaces/IQueueParams.md) |
-| `messageId` | `string` \| `string`[] |
-| `cb` | `ICallback`\<`void`\> |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-QueueMessagesPaginatorSortedSet.deleteMessage
-
-___
-
 ### getMessages
 
 ▸ **getMessages**(`queue`, `cursor`, `pageSize`, `cb`): `void`

diff --git a/docs/api/interfaces/IQueueMessages.md b/docs/api/interfaces/IQueueMessages.md
@@ -11,7 +11,6 @@
 ### Methods
 
 - [countMessages](IQueueMessages.md#countmessages)
-- [deleteMessage](IQueueMessages.md#deletemessage)
 - [getMessages](IQueueMessages.md#getmessages)
 - [purge](IQueueMessages.md#purge)
 
@@ -34,24 +33,6 @@
 
 ___
 
-### deleteMessage
-
-▸ **deleteMessage**(`queue`, `messageId`, `cb`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `queue` | `string` \| [`IQueueParams`](IQueueParams.md) |
-| `messageId` | `string` |
-| `cb` | `ICallback`\<`void`\> |
-
-#### Returns
-
-`void`
-
-___
-
 ### getMessages
 
 ▸ **getMessages**(`queue`, `page`, `pageSize`, `cb`): `void`

diff --git a/docs/scheduling-messages.md b/docs/scheduling-messages.md
@@ -30,11 +30,8 @@ producer.produce(message, (err) => {
 })
 ```
 
-For managing scheduled messages, the [QueueScheduledMessages Class](api/classes/QueueScheduledMessages.md) provides:
+For managing scheduled messages see [QueueScheduledMessages Class](api/classes/QueueScheduledMessages.md).
 
-* [QueueScheduledMessages.prototype.getMessages()](api/classes/QueueScheduledMessages.md#getmessages)
-* [QueueScheduledMessages.prototype.deleteMessage()](api/classes/QueueScheduledMessages.md#deletemessage)
-* [QueueScheduledMessages.prototype.purge()](api/classes/QueueScheduledMessages.md#purge)
-* [QueueScheduledMessages.prototype.countMessages()](api/classes/QueueScheduledMessages.md#countmessages)
+To delete a scheduled message see [QueueMessages.deleteMessageById()](api/classes/QueueMessages.md#deletemessagebyid).
 
 Scheduled messages can be also managed using the [HTTP API Interface](https://github.com/weyoss/redis-smq-monitor) or from your browser with the help of the [Web UI](https://github.com/weyoss/redis-smq-monitor-client).