@amqp-contract/client-nestjs 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/index.md +12 -12
- package/package.json +3 -3
package/docs/index.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
### AmqpClientModule
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/client-nestjs/src/client.module.ts:14](https://github.com/btravers/amqp-contract/blob/
|
|
11
|
+
Defined in: [packages/client-nestjs/src/client.module.ts:14](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/client-nestjs/src/client.module.ts#L14)
|
|
12
12
|
|
|
13
13
|
NestJS module for AMQP client integration
|
|
14
14
|
This module provides type-safe AMQP client functionality using @amqp-contract/client
|
|
@@ -55,7 +55,7 @@ ConfigurableModuleClass.constructor
|
|
|
55
55
|
|
|
56
56
|
### AmqpClientService
|
|
57
57
|
|
|
58
|
-
Defined in: [packages/client-nestjs/src/client.service.ts:86](https://github.com/btravers/amqp-contract/blob/
|
|
58
|
+
Defined in: [packages/client-nestjs/src/client.service.ts:86](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/client-nestjs/src/client.service.ts#L86)
|
|
59
59
|
|
|
60
60
|
Type-safe AMQP client service for NestJS applications.
|
|
61
61
|
|
|
@@ -120,7 +120,7 @@ export class OrderService {
|
|
|
120
120
|
new AmqpClientService<TContract>(options): AmqpClientService<TContract>;
|
|
121
121
|
```
|
|
122
122
|
|
|
123
|
-
Defined in: [packages/client-nestjs/src/client.service.ts:91](https://github.com/btravers/amqp-contract/blob/
|
|
123
|
+
Defined in: [packages/client-nestjs/src/client.service.ts:91](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/client-nestjs/src/client.service.ts#L91)
|
|
124
124
|
|
|
125
125
|
###### Parameters
|
|
126
126
|
|
|
@@ -140,7 +140,7 @@ Defined in: [packages/client-nestjs/src/client.service.ts:91](https://github.com
|
|
|
140
140
|
onModuleDestroy(): Promise<void>;
|
|
141
141
|
```
|
|
142
142
|
|
|
143
|
-
Defined in: [packages/client-nestjs/src/client.service.ts:118](https://github.com/btravers/amqp-contract/blob/
|
|
143
|
+
Defined in: [packages/client-nestjs/src/client.service.ts:118](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/client-nestjs/src/client.service.ts#L118)
|
|
144
144
|
|
|
145
145
|
Close the AMQP client when the NestJS module is destroyed.
|
|
146
146
|
|
|
@@ -164,7 +164,7 @@ OnModuleDestroy.onModuleDestroy
|
|
|
164
164
|
onModuleInit(): Promise<void>;
|
|
165
165
|
```
|
|
166
166
|
|
|
167
|
-
Defined in: [packages/client-nestjs/src/client.service.ts:103](https://github.com/btravers/amqp-contract/blob/
|
|
167
|
+
Defined in: [packages/client-nestjs/src/client.service.ts:103](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/client-nestjs/src/client.service.ts#L103)
|
|
168
168
|
|
|
169
169
|
Initialize the AMQP client when the NestJS module starts.
|
|
170
170
|
|
|
@@ -191,7 +191,7 @@ publish<TName>(
|
|
|
191
191
|
options?): Future<Result<boolean, TechnicalError | MessageValidationError>>;
|
|
192
192
|
```
|
|
193
193
|
|
|
194
|
-
Defined in: [packages/client-nestjs/src/client.service.ts:148](https://github.com/btravers/amqp-contract/blob/
|
|
194
|
+
Defined in: [packages/client-nestjs/src/client.service.ts:148](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/client-nestjs/src/client.service.ts#L148)
|
|
195
195
|
|
|
196
196
|
Publish a message using a contract-defined publisher.
|
|
197
197
|
|
|
@@ -235,7 +235,7 @@ if (result.isError()) {
|
|
|
235
235
|
|
|
236
236
|
### AmqpClientModuleOptions
|
|
237
237
|
|
|
238
|
-
Defined in: [packages/client-nestjs/src/client.service.ts:30](https://github.com/btravers/amqp-contract/blob/
|
|
238
|
+
Defined in: [packages/client-nestjs/src/client.service.ts:30](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/client-nestjs/src/client.service.ts#L30)
|
|
239
239
|
|
|
240
240
|
Configuration options for the AMQP client NestJS module.
|
|
241
241
|
|
|
@@ -261,9 +261,9 @@ const options: AmqpClientModuleOptions<typeof contract> = {
|
|
|
261
261
|
|
|
262
262
|
| Property | Type | Description | Defined in |
|
|
263
263
|
| ------ | ------ | ------ | ------ |
|
|
264
|
-
| <a id="connectionoptions"></a> `connectionOptions?` | `AmqpConnectionManagerOptions` | Optional connection configuration (heartbeat, reconnect settings, etc.) | [packages/client-nestjs/src/client.service.ts:36](https://github.com/btravers/amqp-contract/blob/
|
|
265
|
-
| <a id="contract"></a> `contract` | `TContract` | The AMQP contract definition specifying publishers and their message schemas | [packages/client-nestjs/src/client.service.ts:32](https://github.com/btravers/amqp-contract/blob/
|
|
266
|
-
| <a id="urls"></a> `urls` | `ConnectionUrl`[] | AMQP broker URL(s). Multiple URLs provide failover support | [packages/client-nestjs/src/client.service.ts:34](https://github.com/btravers/amqp-contract/blob/
|
|
264
|
+
| <a id="connectionoptions"></a> `connectionOptions?` | `AmqpConnectionManagerOptions` | Optional connection configuration (heartbeat, reconnect settings, etc.) | [packages/client-nestjs/src/client.service.ts:36](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/client-nestjs/src/client.service.ts#L36) |
|
|
265
|
+
| <a id="contract"></a> `contract` | `TContract` | The AMQP contract definition specifying publishers and their message schemas | [packages/client-nestjs/src/client.service.ts:32](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/client-nestjs/src/client.service.ts#L32) |
|
|
266
|
+
| <a id="urls"></a> `urls` | `ConnectionUrl`[] | AMQP broker URL(s). Multiple URLs provide failover support | [packages/client-nestjs/src/client.service.ts:34](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/client-nestjs/src/client.service.ts#L34) |
|
|
267
267
|
|
|
268
268
|
## Type Aliases
|
|
269
269
|
|
|
@@ -273,7 +273,7 @@ const options: AmqpClientModuleOptions<typeof contract> = {
|
|
|
273
273
|
type ClientInferPublisherInput<TContract, TName> = PublisherInferInput<InferPublisher<TContract, TName>>;
|
|
274
274
|
```
|
|
275
275
|
|
|
276
|
-
Defined in: packages/client/dist/index.d.mts:
|
|
276
|
+
Defined in: packages/client/dist/index.d.mts:52
|
|
277
277
|
|
|
278
278
|
Infer publisher input type (message payload) for a specific publisher in a contract
|
|
279
279
|
|
|
@@ -292,4 +292,4 @@ Infer publisher input type (message payload) for a specific publisher in a contr
|
|
|
292
292
|
MODULE_OPTIONS_TOKEN: string | symbol;
|
|
293
293
|
```
|
|
294
294
|
|
|
295
|
-
Defined in: [packages/client-nestjs/src/client.module-definition.ts:9](https://github.com/btravers/amqp-contract/blob/
|
|
295
|
+
Defined in: [packages/client-nestjs/src/client.module-definition.ts:9](https://github.com/btravers/amqp-contract/blob/2e0e3a372088cd269fea97fb73812491d1fc5e14/packages/client-nestjs/src/client.module-definition.ts#L9)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@amqp-contract/client-nestjs",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.2",
|
|
4
4
|
"description": "NestJS integration for @amqp-contract/client",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"amqp",
|
|
@@ -43,8 +43,8 @@
|
|
|
43
43
|
"docs"
|
|
44
44
|
],
|
|
45
45
|
"dependencies": {
|
|
46
|
-
"@amqp-contract/client": "0.3.
|
|
47
|
-
"@amqp-contract/contract": "0.3.
|
|
46
|
+
"@amqp-contract/client": "0.3.2",
|
|
47
|
+
"@amqp-contract/contract": "0.3.2"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"@nestjs/common": "11.1.10",
|