Skip to content

Commit d30542e

Browse files
author
Weyoss
committed
docs(redis-smq): update class references
1 parent 3c07bae commit d30542e

File tree

7 files changed

+90
-16
lines changed

7 files changed

+90
-16
lines changed

‎packages/redis-smq/docs/api/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@
105105
- [IConsumerMessageHandlerArgs](interfaces/IConsumerMessageHandlerArgs.md)
106106
- [IEventBusConfig](interfaces/IEventBusConfig.md)
107107
- [IExchange](interfaces/IExchange.md)
108+
- [IMessageDeleteResponse](interfaces/IMessageDeleteResponse.md)
108109
- [IMessageParams](interfaces/IMessageParams.md)
109110
- [IMessageStateTransferable](interfaces/IMessageStateTransferable.md)
110111
- [IMessageTransferable](interfaces/IMessageTransferable.md)
@@ -144,6 +145,8 @@
144145
- [TExchangeTopicTransferable](README.md#texchangetopictransferable)
145146
- [TExchangeTransferable](README.md#texchangetransferable)
146147
- [TMessageConsumeOptions](README.md#tmessageconsumeoptions)
148+
- [TMessageDeleteRawResponse](README.md#tmessagedeleterawresponse)
149+
- [TMessageDeleteStatus](README.md#tmessagedeletestatus)
147150
- [TMessageUnacknowledgementAction](README.md#tmessageunacknowledgementaction)
148151
- [TMessageUnacknowledgementStatus](README.md#tmessageunacknowledgementstatus)
149152
- [TProducerEvent](README.md#tproducerevent)
@@ -371,6 +374,18 @@ ___
371374

372375
___
373376

377+
### TMessageDeleteRawResponse
378+
379+
Ƭ **TMessageDeleteRawResponse**: [`TMessageDeleteStatus`](README.md#tmessagedeletestatus) \| [`number`, `number`, `number`, `number`]
380+
381+
___
382+
383+
### TMessageDeleteStatus
384+
385+
Ƭ **TMessageDeleteStatus**: ``"OK"`` \| ``"PARTIAL_SUCCESS"`` \| ``"MESSAGE_NOT_FOUND"`` \| ``"MESSAGE_IN_PROCESS"`` \| ``"MESSAGE_NOT_DELETED"`` \| ``"INVALID_PARAMETERS"``
386+
387+
___
388+
374389
### TMessageUnacknowledgementAction
375390

376391
Ƭ **TMessageUnacknowledgementAction**: \{ `action`: [`REQUEUE`](enums/EMessageUnacknowledgementAction.md#requeue) \| [`DELAY`](enums/EMessageUnacknowledgementAction.md#delay) } \| \{ `action`: [`DEAD_LETTER`](enums/EMessageUnacknowledgementAction.md#dead_letter) ; `deadLetterReason`: [`EMessageUnacknowledgementDeadLetterReason`](enums/EMessageUnacknowledgementDeadLetterReason.md) }

‎packages/redis-smq/docs/api/classes/Message.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Deletes a message with the given ID.
4545
| Name | Type | Description |
4646
| :------ | :------ | :------ |
4747
| `id` | `string` | The ID of the message to delete. |
48-
| `cb` | `ICallback`\<`void`\> | A callback function that will be called with the result. If an error occurs, the first parameter will be an Error object. Otherwise, the second parameter will be undefined. |
48+
| `cb` | `ICallback`\<[`IMessageDeleteResponse`](../interfaces/IMessageDeleteResponse.md)\> | A callback function that will be called with the result. If an error occurs, the first parameter will be an Error object. Otherwise, the second parameter will contain the deletion response. |
4949

5050
#### Returns
5151

@@ -57,14 +57,14 @@ ___
5757

5858
▸ **deleteMessagesByIds**(`ids`, `cb`): `void`
5959

60-
Deletes messages with the given IDs.
60+
Deletes multiple messages by their IDs
6161

6262
#### Parameters
6363

6464
| Name | Type | Description |
6565
| :------ | :------ | :------ |
66-
| `ids` | `string`[] | An array of IDs of the messages to delete. |
67-
| `cb` | `ICallback`\<`void`\> | A callback function that will be called with the result. If an error occurs, the first parameter will be an Error object. Otherwise, the second parameter will be undefined. |
66+
| `ids` | `string`[] | Array of message IDs to delete |
67+
| `cb` | `ICallback`\<[`IMessageDeleteResponse`](../interfaces/IMessageDeleteResponse.md)\> | Callback function that will be called with the deletion result If an error occurs, the first parameter will be an Error object Otherwise, the second parameter will contain the deletion response |
6868

6969
#### Returns
7070

‎packages/redis-smq/docs/api/classes/QueueAcknowledgedMessages.md‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,21 @@ ___
8989

9090
▸ **purge**(`queue`, `cb`): `void`
9191

92-
Purges all messages from the queue.
92+
Purges all messages from the specified queue.
93+
94+
Different message types can be purged using specific classes:
95+
- [QueueMessages](QueueMessages.md) - Delete all queue messages
96+
- [QueueAcknowledgedMessages](QueueAcknowledgedMessages.md) - Delete acknowledged messages (if configured to be stored)
97+
- [QueueDeadLetteredMessages](QueueDeadLetteredMessages.md) - Delete dead-lettered messages (if configured to be stored)
98+
- [QueueScheduledMessages](QueueScheduledMessages.md) - Delete scheduled messages
99+
- [QueuePendingMessages](QueuePendingMessages.md) - Delete pending messages
93100

94101
#### Parameters
95102

96103
| Name | Type | Description |
97104
| :------ | :------ | :------ |
98-
| `queue` | [`TQueueExtendedParams`](../README.md#tqueueextendedparams) | Extended queue parameters |
99-
| `cb` | `ICallback`\<`void`\> | Callback function |
105+
| `queue` | [`TQueueExtendedParams`](../README.md#tqueueextendedparams) | The queue to purge. Can be a string, queue parameters object, or queue consumer group parameters. |
106+
| `cb` | `ICallback`\<`void`\> | Callback function that will be invoked when the operation completes. If an error occurs, the first parameter will contain the Error object. Otherwise, the first parameter will be null/undefined. |
100107

101108
#### Returns
102109

‎packages/redis-smq/docs/api/classes/QueueDeadLetteredMessages.md‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,21 @@ ___
8989

9090
▸ **purge**(`queue`, `cb`): `void`
9191

92-
Purges all messages from the queue.
92+
Purges all messages from the specified queue.
93+
94+
Different message types can be purged using specific classes:
95+
- [QueueMessages](QueueMessages.md) - Delete all queue messages
96+
- [QueueAcknowledgedMessages](QueueAcknowledgedMessages.md) - Delete acknowledged messages (if configured to be stored)
97+
- [QueueDeadLetteredMessages](QueueDeadLetteredMessages.md) - Delete dead-lettered messages (if configured to be stored)
98+
- [QueueScheduledMessages](QueueScheduledMessages.md) - Delete scheduled messages
99+
- [QueuePendingMessages](QueuePendingMessages.md) - Delete pending messages
93100

94101
#### Parameters
95102

96103
| Name | Type | Description |
97104
| :------ | :------ | :------ |
98-
| `queue` | [`TQueueExtendedParams`](../README.md#tqueueextendedparams) | Extended queue parameters |
99-
| `cb` | `ICallback`\<`void`\> | Callback function |
105+
| `queue` | [`TQueueExtendedParams`](../README.md#tqueueextendedparams) | The queue to purge. Can be a string, queue parameters object, or queue consumer group parameters. |
106+
| `cb` | `ICallback`\<`void`\> | Callback function that will be invoked when the operation completes. If an error occurs, the first parameter will contain the Error object. Otherwise, the first parameter will be null/undefined. |
100107

101108
#### Returns
102109

‎packages/redis-smq/docs/api/classes/QueueMessages.md‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,14 +113,21 @@ ___
113113

114114
▸ **purge**(`queue`, `cb`): `void`
115115

116-
Purges all messages from the queue.
116+
Purges all messages from the specified queue.
117+
118+
Different message types can be purged using specific classes:
119+
- [QueueMessages](QueueMessages.md) - Delete all queue messages
120+
- [QueueAcknowledgedMessages](QueueAcknowledgedMessages.md) - Delete acknowledged messages (if configured to be stored)
121+
- [QueueDeadLetteredMessages](QueueDeadLetteredMessages.md) - Delete dead-lettered messages (if configured to be stored)
122+
- [QueueScheduledMessages](QueueScheduledMessages.md) - Delete scheduled messages
123+
- [QueuePendingMessages](QueuePendingMessages.md) - Delete pending messages
117124

118125
#### Parameters
119126

120127
| Name | Type | Description |
121128
| :------ | :------ | :------ |
122-
| `queue` | [`TQueueExtendedParams`](../README.md#tqueueextendedparams) | Extended queue parameters |
123-
| `cb` | `ICallback`\<`void`\> | Callback function |
129+
| `queue` | [`TQueueExtendedParams`](../README.md#tqueueextendedparams) | The queue to purge. Can be a string, queue parameters object, or queue consumer group parameters. |
130+
| `cb` | `ICallback`\<`void`\> | Callback function that will be invoked when the operation completes. If an error occurs, the first parameter will contain the Error object. Otherwise, the first parameter will be null/undefined. |
124131

125132
#### Returns
126133

‎packages/redis-smq/docs/api/classes/QueueScheduledMessages.md‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,21 @@ ___
8989

9090
▸ **purge**(`queue`, `cb`): `void`
9191

92-
Purges all messages from the queue.
92+
Purges all messages from the specified queue.
93+
94+
Different message types can be purged using specific classes:
95+
- [QueueMessages](QueueMessages.md) - Delete all queue messages
96+
- [QueueAcknowledgedMessages](QueueAcknowledgedMessages.md) - Delete acknowledged messages (if configured to be stored)
97+
- [QueueDeadLetteredMessages](QueueDeadLetteredMessages.md) - Delete dead-lettered messages (if configured to be stored)
98+
- [QueueScheduledMessages](QueueScheduledMessages.md) - Delete scheduled messages
99+
- [QueuePendingMessages](QueuePendingMessages.md) - Delete pending messages
93100

94101
#### Parameters
95102

96103
| Name | Type | Description |
97104
| :------ | :------ | :------ |
98-
| `queue` | [`TQueueExtendedParams`](../README.md#tqueueextendedparams) | Extended queue parameters |
99-
| `cb` | `ICallback`\<`void`\> | Callback function |
105+
| `queue` | [`TQueueExtendedParams`](../README.md#tqueueextendedparams) | The queue to purge. Can be a string, queue parameters object, or queue consumer group parameters. |
106+
| `cb` | `ICallback`\<`void`\> | Callback function that will be invoked when the operation completes. If an error occurs, the first parameter will contain the Error object. Otherwise, the first parameter will be null/undefined. |
100107

101108
#### Returns
102109

‎packages/redis-smq/docs/api/interfaces/IMessageDeleteResponse.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[RedisSMQ](../../../README.md) / [Docs](../../README.md) / [API Reference](../README.md) / IMessageDeleteResponse
2+
3+
# Interface: IMessageDeleteResponse
4+
5+
## Table of contents
6+
7+
### Properties
8+
9+
- [stats](IMessageDeleteResponse.md#stats)
10+
- [status](IMessageDeleteResponse.md#status)
11+
12+
## Properties
13+
14+
### stats
15+
16+
• **stats**: `Object`
17+
18+
#### Type declaration
19+
20+
| Name | Type |
21+
| :------ | :------ |
22+
| `inProcess` | `number` |
23+
| `notFound` | `number` |
24+
| `processed` | `number` |
25+
| `success` | `number` |
26+
27+
___
28+
29+
### status
30+
31+
• **status**: [`TMessageDeleteStatus`](../README.md#tmessagedeletestatus)

0 commit comments

Comments
 (0)