@amqp-contract/client-nestjs 0.5.0 → 0.6.0
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 +18 -18
- package/package.json +4 -4
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:93](https://github.com/btravers/amqp-contract/blob/
|
|
11
|
+
Defined in: [packages/client-nestjs/src/client.module.ts:93](https://github.com/btravers/amqp-contract/blob/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.module.ts#L93)
|
|
12
12
|
|
|
13
13
|
NestJS module for AMQP client integration
|
|
14
14
|
This module provides type-safe AMQP client functionality using @amqp-contract/client
|
|
@@ -84,7 +84,7 @@ new AmqpClientModule(): AmqpClientModule;
|
|
|
84
84
|
static forRoot<TContract>(options): DynamicModule;
|
|
85
85
|
```
|
|
86
86
|
|
|
87
|
-
Defined in: [packages/client-nestjs/src/client.module.ts:100](https://github.com/btravers/amqp-contract/blob/
|
|
87
|
+
Defined in: [packages/client-nestjs/src/client.module.ts:100](https://github.com/btravers/amqp-contract/blob/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.module.ts#L100)
|
|
88
88
|
|
|
89
89
|
Register the AMQP client module with synchronous configuration
|
|
90
90
|
|
|
@@ -112,7 +112,7 @@ A dynamic module for NestJS
|
|
|
112
112
|
static forRootAsync<TContract>(options): DynamicModule;
|
|
113
113
|
```
|
|
114
114
|
|
|
115
|
-
Defined in: [packages/client-nestjs/src/client.module.ts:122](https://github.com/btravers/amqp-contract/blob/
|
|
115
|
+
Defined in: [packages/client-nestjs/src/client.module.ts:122](https://github.com/btravers/amqp-contract/blob/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.module.ts#L122)
|
|
116
116
|
|
|
117
117
|
Register the AMQP client module with asynchronous configuration
|
|
118
118
|
|
|
@@ -138,11 +138,11 @@ A dynamic module for NestJS
|
|
|
138
138
|
|
|
139
139
|
### AmqpClientService
|
|
140
140
|
|
|
141
|
-
Defined in: [packages/client-nestjs/src/client.service.ts:86](https://github.com/btravers/amqp-contract/blob/
|
|
141
|
+
Defined in: [packages/client-nestjs/src/client.service.ts:86](https://github.com/btravers/amqp-contract/blob/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.service.ts#L86)
|
|
142
142
|
|
|
143
143
|
Type-safe AMQP client service for NestJS applications.
|
|
144
144
|
|
|
145
|
-
This service wraps TypedAmqpClient and integrates it with the NestJS
|
|
145
|
+
This service wraps [TypedAmqpClient](https://btravers.github.io/amqp-contract/api/client#typedamqpclient) and integrates it with the NestJS
|
|
146
146
|
lifecycle, automatically initializing the connection on module init and
|
|
147
147
|
cleaning up resources on module destroy.
|
|
148
148
|
|
|
@@ -203,7 +203,7 @@ export class OrderService {
|
|
|
203
203
|
new AmqpClientService<TContract>(options): AmqpClientService<TContract>;
|
|
204
204
|
```
|
|
205
205
|
|
|
206
|
-
Defined in: [packages/client-nestjs/src/client.service.ts:91](https://github.com/btravers/amqp-contract/blob/
|
|
206
|
+
Defined in: [packages/client-nestjs/src/client.service.ts:91](https://github.com/btravers/amqp-contract/blob/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.service.ts#L91)
|
|
207
207
|
|
|
208
208
|
###### Parameters
|
|
209
209
|
|
|
@@ -223,7 +223,7 @@ Defined in: [packages/client-nestjs/src/client.service.ts:91](https://github.com
|
|
|
223
223
|
onModuleDestroy(): Promise<void>;
|
|
224
224
|
```
|
|
225
225
|
|
|
226
|
-
Defined in: [packages/client-nestjs/src/client.service.ts:118](https://github.com/btravers/amqp-contract/blob/
|
|
226
|
+
Defined in: [packages/client-nestjs/src/client.service.ts:118](https://github.com/btravers/amqp-contract/blob/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.service.ts#L118)
|
|
227
227
|
|
|
228
228
|
Close the AMQP client when the NestJS module is destroyed.
|
|
229
229
|
|
|
@@ -247,7 +247,7 @@ OnModuleDestroy.onModuleDestroy
|
|
|
247
247
|
onModuleInit(): Promise<void>;
|
|
248
248
|
```
|
|
249
249
|
|
|
250
|
-
Defined in: [packages/client-nestjs/src/client.service.ts:103](https://github.com/btravers/amqp-contract/blob/
|
|
250
|
+
Defined in: [packages/client-nestjs/src/client.service.ts:103](https://github.com/btravers/amqp-contract/blob/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.service.ts#L103)
|
|
251
251
|
|
|
252
252
|
Initialize the AMQP client when the NestJS module starts.
|
|
253
253
|
|
|
@@ -276,7 +276,7 @@ publish<TName>(
|
|
|
276
276
|
| MessageValidationError>>;
|
|
277
277
|
```
|
|
278
278
|
|
|
279
|
-
Defined in: [packages/client-nestjs/src/client.service.ts:148](https://github.com/btravers/amqp-contract/blob/
|
|
279
|
+
Defined in: [packages/client-nestjs/src/client.service.ts:148](https://github.com/btravers/amqp-contract/blob/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.service.ts#L148)
|
|
280
280
|
|
|
281
281
|
Publish a message using a contract-defined publisher.
|
|
282
282
|
|
|
@@ -371,7 +371,7 @@ This includes validation failures and AMQP channel issues
|
|
|
371
371
|
type AmqpClientModuleAsyncOptions<TContract> = object;
|
|
372
372
|
```
|
|
373
373
|
|
|
374
|
-
Defined in: [packages/client-nestjs/src/client.module.ts:22](https://github.com/btravers/amqp-contract/blob/
|
|
374
|
+
Defined in: [packages/client-nestjs/src/client.module.ts:22](https://github.com/btravers/amqp-contract/blob/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.module.ts#L22)
|
|
375
375
|
|
|
376
376
|
Options for async module configuration using factory pattern
|
|
377
377
|
|
|
@@ -385,9 +385,9 @@ Options for async module configuration using factory pattern
|
|
|
385
385
|
|
|
386
386
|
| Property | Type | Description | Defined in |
|
|
387
387
|
| ------ | ------ | ------ | ------ |
|
|
388
|
-
| <a id="imports"></a> `imports?` | `ModuleMetadata`\[`"imports"`\] | Optional list of imported modules that export providers needed by the factory | [packages/client-nestjs/src/client.module.ts:37](https://github.com/btravers/amqp-contract/blob/
|
|
389
|
-
| <a id="inject"></a> `inject?` | (`string` \| `symbol` \| `Type`\<`unknown`\>)[] | Optional dependencies to inject into the factory function. Can be a token (string/symbol) or a class reference to a provider. | [packages/client-nestjs/src/client.module.ts:33](https://github.com/btravers/amqp-contract/blob/
|
|
390
|
-
| <a id="usefactory"></a> `useFactory` | (...`args`) => `AmqpClientModuleOptionsFactory`\<`TContract`\> | Factory function that returns the module options. Can use injected dependencies to create configuration. | [packages/client-nestjs/src/client.module.ts:28](https://github.com/btravers/amqp-contract/blob/
|
|
388
|
+
| <a id="imports"></a> `imports?` | `ModuleMetadata`\[`"imports"`\] | Optional list of imported modules that export providers needed by the factory | [packages/client-nestjs/src/client.module.ts:37](https://github.com/btravers/amqp-contract/blob/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.module.ts#L37) |
|
|
389
|
+
| <a id="inject"></a> `inject?` | (`string` \| `symbol` \| `Type`\<`unknown`\>)[] | Optional dependencies to inject into the factory function. Can be a token (string/symbol) or a class reference to a provider. | [packages/client-nestjs/src/client.module.ts:33](https://github.com/btravers/amqp-contract/blob/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.module.ts#L33) |
|
|
390
|
+
| <a id="usefactory"></a> `useFactory` | (...`args`) => `AmqpClientModuleOptionsFactory`\<`TContract`\> | Factory function that returns the module options. Can use injected dependencies to create configuration. | [packages/client-nestjs/src/client.module.ts:28](https://github.com/btravers/amqp-contract/blob/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.module.ts#L28) |
|
|
391
391
|
|
|
392
392
|
***
|
|
393
393
|
|
|
@@ -397,7 +397,7 @@ Options for async module configuration using factory pattern
|
|
|
397
397
|
type AmqpClientModuleOptions<TContract> = object;
|
|
398
398
|
```
|
|
399
399
|
|
|
400
|
-
Defined in: [packages/client-nestjs/src/client.service.ts:30](https://github.com/btravers/amqp-contract/blob/
|
|
400
|
+
Defined in: [packages/client-nestjs/src/client.service.ts:30](https://github.com/btravers/amqp-contract/blob/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.service.ts#L30)
|
|
401
401
|
|
|
402
402
|
Configuration options for the AMQP client NestJS module.
|
|
403
403
|
|
|
@@ -423,9 +423,9 @@ const options: AmqpClientModuleOptions<typeof contract> = {
|
|
|
423
423
|
|
|
424
424
|
| Property | Type | Description | Defined in |
|
|
425
425
|
| ------ | ------ | ------ | ------ |
|
|
426
|
-
| <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/
|
|
427
|
-
| <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/
|
|
428
|
-
| <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/
|
|
426
|
+
| <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/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.service.ts#L36) |
|
|
427
|
+
| <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/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.service.ts#L32) |
|
|
428
|
+
| <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/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.service.ts#L34) |
|
|
429
429
|
|
|
430
430
|
***
|
|
431
431
|
|
|
@@ -454,7 +454,7 @@ Infer publisher input type (message payload) for a specific publisher in a contr
|
|
|
454
454
|
const MODULE_OPTIONS_TOKEN: typeof MODULE_OPTIONS_TOKEN;
|
|
455
455
|
```
|
|
456
456
|
|
|
457
|
-
Defined in: [packages/client-nestjs/src/client.module-definition.ts:5](https://github.com/btravers/amqp-contract/blob/
|
|
457
|
+
Defined in: [packages/client-nestjs/src/client.module-definition.ts:5](https://github.com/btravers/amqp-contract/blob/8711ad20abb1d4e537ec473d43e85fac3ebd4d0b/packages/client-nestjs/src/client.module-definition.ts#L5)
|
|
458
458
|
|
|
459
459
|
Injection token for AMQP client module options
|
|
460
460
|
Used by NestJS DI system to inject configuration into AmqpClientService
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@amqp-contract/client-nestjs",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.0",
|
|
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.
|
|
47
|
-
"@amqp-contract/contract": "0.
|
|
46
|
+
"@amqp-contract/client": "0.6.0",
|
|
47
|
+
"@amqp-contract/contract": "0.6.0"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"@nestjs/common": "11.1.10",
|
|
@@ -64,7 +64,7 @@
|
|
|
64
64
|
"typescript": "5.9.3",
|
|
65
65
|
"vitest": "4.0.16",
|
|
66
66
|
"zod": "4.2.1",
|
|
67
|
-
"@amqp-contract/testing": "0.
|
|
67
|
+
"@amqp-contract/testing": "0.6.0",
|
|
68
68
|
"@amqp-contract/tsconfig": "0.0.0",
|
|
69
69
|
"@amqp-contract/typedoc": "0.0.1"
|
|
70
70
|
},
|