Skip to content

Commit

Permalink
docs: update Message API reference
Browse files Browse the repository at this point in the history
  • Loading branch information
weyoss committed May 4, 2024
1 parent fba8777 commit 9c1fa7a
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 54 deletions.
18 changes: 18 additions & 0 deletions docs/api/classes/Message.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -132,6 +133,23 @@ ___

___

### requeueMessageById

**requeueMessageById**(`messageId`, `cb`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `messageId` | `string` |
| `cb` | `ICallback`\<`void`\> |

#### Returns

`void`

___

### shutdown

**shutdown**(`cb`): `void`
Expand Down
27 changes: 0 additions & 27 deletions docs/api/classes/QueueAcknowledgedMessages.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@

**`QueueAcknowledgedMessages`**

## Implements

- [`IQueueMessagesRequeuable`](../interfaces/IQueueMessagesRequeuable.md)

## Table of contents

### Constructors
Expand All @@ -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
Expand Down Expand Up @@ -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`
Expand Down
27 changes: 0 additions & 27 deletions docs/api/classes/QueueDeadLetteredMessages.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@

**`QueueDeadLetteredMessages`**

## Implements

- [`IQueueMessagesRequeuable`](../interfaces/IQueueMessagesRequeuable.md)

## Table of contents

### Constructors
Expand All @@ -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
Expand Down Expand Up @@ -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`
Expand Down

0 comments on commit 9c1fa7a

Please sign in to comment.