From 9c1fa7a129dd159ad118276fd904232d71bde508 Mon Sep 17 00:00:00 2001 From: Weyoss Date: Sat, 4 May 2024 11:48:17 +0200 Subject: [PATCH] docs: update Message API reference --- docs/api/classes/Message.md | 18 +++++++++++++ docs/api/classes/QueueAcknowledgedMessages.md | 27 ------------------- docs/api/classes/QueueDeadLetteredMessages.md | 27 ------------------- 3 files changed, 18 insertions(+), 54 deletions(-) diff --git a/docs/api/classes/Message.md b/docs/api/classes/Message.md index 8f8a0147..95d46d48 100644 --- a/docs/api/classes/Message.md +++ b/docs/api/classes/Message.md @@ -16,6 +16,7 @@ - [getMessageState](Message.md#getmessagestate) - [getMessageStatus](Message.md#getmessagestatus) - [getMessagesByIds](Message.md#getmessagesbyids) +- [requeueMessageById](Message.md#requeuemessagebyid) - [shutdown](Message.md#shutdown) ## Constructors @@ -132,6 +133,23 @@ ___ ___ +### requeueMessageById + +▸ **requeueMessageById**(`messageId`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `messageId` | `string` | +| `cb` | `ICallback`\<`void`\> | + +#### Returns + +`void` + +___ + ### shutdown ▸ **shutdown**(`cb`): `void` diff --git a/docs/api/classes/QueueAcknowledgedMessages.md b/docs/api/classes/QueueAcknowledgedMessages.md index 7a81bac8..dadaa11e 100644 --- a/docs/api/classes/QueueAcknowledgedMessages.md +++ b/docs/api/classes/QueueAcknowledgedMessages.md @@ -8,10 +8,6 @@ ↳ **`QueueAcknowledgedMessages`** -## Implements - -- [`IQueueMessagesRequeuable`](../interfaces/IQueueMessagesRequeuable.md) - ## Table of contents ### Constructors @@ -23,7 +19,6 @@ - [countMessages](QueueAcknowledgedMessages.md#countmessages) - [getMessages](QueueAcknowledgedMessages.md#getmessages) - [purge](QueueAcknowledgedMessages.md#purge) -- [requeueMessage](QueueAcknowledgedMessages.md#requeuemessage) - [shutdown](QueueAcknowledgedMessages.md#shutdown) ## Constructors @@ -107,28 +102,6 @@ QueueMessagesPaginatorList.purge ___ -### requeueMessage - -▸ **requeueMessage**(`queue`, `messageId`, `cb`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `queue` | `string` \| [`IQueueParams`](../interfaces/IQueueParams.md) | -| `messageId` | `string` | -| `cb` | `ICallback`\<`void`\> | - -#### Returns - -`void` - -#### Implementation of - -[IQueueMessagesRequeuable](../interfaces/IQueueMessagesRequeuable.md).[requeueMessage](../interfaces/IQueueMessagesRequeuable.md#requeuemessage) - -___ - ### shutdown ▸ **shutdown**(`cb`): `void` diff --git a/docs/api/classes/QueueDeadLetteredMessages.md b/docs/api/classes/QueueDeadLetteredMessages.md index 728f23fe..b7eb0eb7 100644 --- a/docs/api/classes/QueueDeadLetteredMessages.md +++ b/docs/api/classes/QueueDeadLetteredMessages.md @@ -8,10 +8,6 @@ ↳ **`QueueDeadLetteredMessages`** -## Implements - -- [`IQueueMessagesRequeuable`](../interfaces/IQueueMessagesRequeuable.md) - ## Table of contents ### Constructors @@ -23,7 +19,6 @@ - [countMessages](QueueDeadLetteredMessages.md#countmessages) - [getMessages](QueueDeadLetteredMessages.md#getmessages) - [purge](QueueDeadLetteredMessages.md#purge) -- [requeueMessage](QueueDeadLetteredMessages.md#requeuemessage) - [shutdown](QueueDeadLetteredMessages.md#shutdown) ## Constructors @@ -107,28 +102,6 @@ QueueMessagesPaginatorList.purge ___ -### requeueMessage - -▸ **requeueMessage**(`queue`, `messageId`, `cb`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `queue` | `string` \| [`IQueueParams`](../interfaces/IQueueParams.md) | -| `messageId` | `string` | -| `cb` | `ICallback`\<`void`\> | - -#### Returns - -`void` - -#### Implementation of - -[IQueueMessagesRequeuable](../interfaces/IQueueMessagesRequeuable.md).[requeueMessage](../interfaces/IQueueMessagesRequeuable.md#requeuemessage) - -___ - ### shutdown ▸ **shutdown**(`cb`): `void`