@amqp-contract/worker 0.3.0 → 0.3.1
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 +20 -20
- package/package.json +6 -6
package/docs/index.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
### MessageValidationError
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/worker/src/errors.ts:35](https://github.com/btravers/amqp-contract/blob/
|
|
11
|
+
Defined in: [packages/worker/src/errors.ts:35](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/errors.ts#L35)
|
|
12
12
|
|
|
13
13
|
Error thrown when message validation fails
|
|
14
14
|
|
|
@@ -24,7 +24,7 @@ Error thrown when message validation fails
|
|
|
24
24
|
new MessageValidationError(consumerName, issues): MessageValidationError;
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/worker/src/errors.ts:36](https://github.com/btravers/amqp-contract/blob/
|
|
27
|
+
Defined in: [packages/worker/src/errors.ts:36](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/errors.ts#L36)
|
|
28
28
|
|
|
29
29
|
###### Parameters
|
|
30
30
|
|
|
@@ -48,8 +48,8 @@ WorkerError.constructor
|
|
|
48
48
|
| Property | Modifier | Type | Description | Inherited from | Defined in |
|
|
49
49
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
50
50
|
| <a id="cause"></a> `cause?` | `public` | `unknown` | - | `WorkerError.cause` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26 |
|
|
51
|
-
| <a id="consumername"></a> `consumerName` | `readonly` | `string` | - | - | [packages/worker/src/errors.ts:37](https://github.com/btravers/amqp-contract/blob/
|
|
52
|
-
| <a id="issues"></a> `issues` | `readonly` | `unknown` | - | - | [packages/worker/src/errors.ts:38](https://github.com/btravers/amqp-contract/blob/
|
|
51
|
+
| <a id="consumername"></a> `consumerName` | `readonly` | `string` | - | - | [packages/worker/src/errors.ts:37](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/errors.ts#L37) |
|
|
52
|
+
| <a id="issues"></a> `issues` | `readonly` | `unknown` | - | - | [packages/worker/src/errors.ts:38](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/errors.ts#L38) |
|
|
53
53
|
| <a id="message"></a> `message` | `public` | `string` | - | `WorkerError.message` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077 |
|
|
54
54
|
| <a id="name"></a> `name` | `public` | `string` | - | `WorkerError.name` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 |
|
|
55
55
|
| <a id="stack"></a> `stack?` | `public` | `string` | - | `WorkerError.stack` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078 |
|
|
@@ -159,7 +159,7 @@ WorkerError.prepareStackTrace
|
|
|
159
159
|
|
|
160
160
|
### TechnicalError
|
|
161
161
|
|
|
162
|
-
Defined in: [packages/worker/src/errors.ts:22](https://github.com/btravers/amqp-contract/blob/
|
|
162
|
+
Defined in: [packages/worker/src/errors.ts:22](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/errors.ts#L22)
|
|
163
163
|
|
|
164
164
|
Error for technical/runtime failures in worker operations
|
|
165
165
|
This includes validation failures, parsing failures, and processing failures
|
|
@@ -176,7 +176,7 @@ This includes validation failures, parsing failures, and processing failures
|
|
|
176
176
|
new TechnicalError(message, cause?): TechnicalError;
|
|
177
177
|
```
|
|
178
178
|
|
|
179
|
-
Defined in: [packages/worker/src/errors.ts:23](https://github.com/btravers/amqp-contract/blob/
|
|
179
|
+
Defined in: [packages/worker/src/errors.ts:23](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/errors.ts#L23)
|
|
180
180
|
|
|
181
181
|
###### Parameters
|
|
182
182
|
|
|
@@ -199,7 +199,7 @@ WorkerError.constructor
|
|
|
199
199
|
|
|
200
200
|
| Property | Modifier | Type | Description | Inherited from | Defined in |
|
|
201
201
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
202
|
-
| <a id="cause-1"></a> `cause?` | `readonly` | `unknown` | - | `WorkerError.cause` | [packages/worker/src/errors.ts:25](https://github.com/btravers/amqp-contract/blob/
|
|
202
|
+
| <a id="cause-1"></a> `cause?` | `readonly` | `unknown` | - | `WorkerError.cause` | [packages/worker/src/errors.ts:25](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/errors.ts#L25) |
|
|
203
203
|
| <a id="message-1"></a> `message` | `public` | `string` | - | `WorkerError.message` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077 |
|
|
204
204
|
| <a id="name-1"></a> `name` | `public` | `string` | - | `WorkerError.name` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 |
|
|
205
205
|
| <a id="stack-1"></a> `stack?` | `public` | `string` | - | `WorkerError.stack` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078 |
|
|
@@ -309,7 +309,7 @@ WorkerError.prepareStackTrace
|
|
|
309
309
|
|
|
310
310
|
### TypedAmqpWorker
|
|
311
311
|
|
|
312
|
-
Defined in: [packages/worker/src/worker.ts:80](https://github.com/btravers/amqp-contract/blob/
|
|
312
|
+
Defined in: [packages/worker/src/worker.ts:80](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/worker.ts#L80)
|
|
313
313
|
|
|
314
314
|
Type-safe AMQP worker for consuming messages from RabbitMQ.
|
|
315
315
|
|
|
@@ -363,7 +363,7 @@ await worker.close().resultToPromise();
|
|
|
363
363
|
close(): Future<Result<void, TechnicalError>>;
|
|
364
364
|
```
|
|
365
365
|
|
|
366
|
-
Defined in: [packages/worker/src/worker.ts:150](https://github.com/btravers/amqp-contract/blob/
|
|
366
|
+
Defined in: [packages/worker/src/worker.ts:150](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/worker.ts#L150)
|
|
367
367
|
|
|
368
368
|
Close the AMQP channel and connection.
|
|
369
369
|
|
|
@@ -391,7 +391,7 @@ if (closeResult.isOk()) {
|
|
|
391
391
|
static create<TContract>(options): Future<Result<TypedAmqpWorker<TContract>, TechnicalError>>;
|
|
392
392
|
```
|
|
393
393
|
|
|
394
|
-
Defined in: [packages/worker/src/worker.ts:113](https://github.com/btravers/amqp-contract/blob/
|
|
394
|
+
Defined in: [packages/worker/src/worker.ts:113](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/worker.ts#L113)
|
|
395
395
|
|
|
396
396
|
Create a type-safe AMQP worker from a contract.
|
|
397
397
|
|
|
@@ -442,7 +442,7 @@ if (workerResult.isError()) {
|
|
|
442
442
|
type CreateWorkerOptions<TContract> = object;
|
|
443
443
|
```
|
|
444
444
|
|
|
445
|
-
Defined in: [packages/worker/src/worker.ts:29](https://github.com/btravers/amqp-contract/blob/
|
|
445
|
+
Defined in: [packages/worker/src/worker.ts:29](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/worker.ts#L29)
|
|
446
446
|
|
|
447
447
|
Options for creating a type-safe AMQP worker.
|
|
448
448
|
|
|
@@ -473,10 +473,10 @@ const options: CreateWorkerOptions<typeof contract> = {
|
|
|
473
473
|
|
|
474
474
|
| Property | Type | Description | Defined in |
|
|
475
475
|
| ------ | ------ | ------ | ------ |
|
|
476
|
-
| <a id="connectionoptions"></a> `connectionOptions?` | `AmqpConnectionManagerOptions` | Optional connection configuration (heartbeat, reconnect settings, etc.) | [packages/worker/src/worker.ts:37](https://github.com/btravers/amqp-contract/blob/
|
|
477
|
-
| <a id="contract"></a> `contract` | `TContract` | The AMQP contract definition specifying consumers and their message schemas | [packages/worker/src/worker.ts:31](https://github.com/btravers/amqp-contract/blob/
|
|
478
|
-
| <a id="handlers"></a> `handlers` | [`WorkerInferConsumerHandlers`](#workerinferconsumerhandlers)\<`TContract`\> | Handlers for each consumer defined in the contract | [packages/worker/src/worker.ts:33](https://github.com/btravers/amqp-contract/blob/
|
|
479
|
-
| <a id="urls"></a> `urls` | `ConnectionUrl`[] | AMQP broker URL(s). Multiple URLs provide failover support | [packages/worker/src/worker.ts:35](https://github.com/btravers/amqp-contract/blob/
|
|
476
|
+
| <a id="connectionoptions"></a> `connectionOptions?` | `AmqpConnectionManagerOptions` | Optional connection configuration (heartbeat, reconnect settings, etc.) | [packages/worker/src/worker.ts:37](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/worker.ts#L37) |
|
|
477
|
+
| <a id="contract"></a> `contract` | `TContract` | The AMQP contract definition specifying consumers and their message schemas | [packages/worker/src/worker.ts:31](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/worker.ts#L31) |
|
|
478
|
+
| <a id="handlers"></a> `handlers` | [`WorkerInferConsumerHandlers`](#workerinferconsumerhandlers)\<`TContract`\> | Handlers for each consumer defined in the contract | [packages/worker/src/worker.ts:33](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/worker.ts#L33) |
|
|
479
|
+
| <a id="urls"></a> `urls` | `ConnectionUrl`[] | AMQP broker URL(s). Multiple URLs provide failover support | [packages/worker/src/worker.ts:35](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/worker.ts#L35) |
|
|
480
480
|
|
|
481
481
|
***
|
|
482
482
|
|
|
@@ -486,7 +486,7 @@ const options: CreateWorkerOptions<typeof contract> = {
|
|
|
486
486
|
type WorkerInferConsumerHandler<TContract, TName> = (message) => Promise<void>;
|
|
487
487
|
```
|
|
488
488
|
|
|
489
|
-
Defined in: [packages/worker/src/types.ts:45](https://github.com/btravers/amqp-contract/blob/
|
|
489
|
+
Defined in: [packages/worker/src/types.ts:45](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/types.ts#L45)
|
|
490
490
|
|
|
491
491
|
Infer consumer handler type for a specific consumer
|
|
492
492
|
|
|
@@ -515,7 +515,7 @@ Infer consumer handler type for a specific consumer
|
|
|
515
515
|
type WorkerInferConsumerHandlers<TContract> = { [K in InferConsumerNames<TContract>]: WorkerInferConsumerHandler<TContract, K> };
|
|
516
516
|
```
|
|
517
517
|
|
|
518
|
-
Defined in: [packages/worker/src/types.ts:53](https://github.com/btravers/amqp-contract/blob/
|
|
518
|
+
Defined in: [packages/worker/src/types.ts:53](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/types.ts#L53)
|
|
519
519
|
|
|
520
520
|
Infer all consumer handlers for a contract
|
|
521
521
|
|
|
@@ -533,7 +533,7 @@ Infer all consumer handlers for a contract
|
|
|
533
533
|
type WorkerInferConsumerInput<TContract, TName> = ConsumerInferInput<InferConsumer<TContract, TName>>;
|
|
534
534
|
```
|
|
535
535
|
|
|
536
|
-
Defined in: [packages/worker/src/types.ts:37](https://github.com/btravers/amqp-contract/blob/
|
|
536
|
+
Defined in: [packages/worker/src/types.ts:37](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/types.ts#L37)
|
|
537
537
|
|
|
538
538
|
Worker perspective types - for consuming messages
|
|
539
539
|
|
|
@@ -555,7 +555,7 @@ function defineHandler<TContract, TName>(
|
|
|
555
555
|
handler): WorkerInferConsumerHandler<TContract, TName>;
|
|
556
556
|
```
|
|
557
557
|
|
|
558
|
-
Defined in: [packages/worker/src/handlers.ts:73](https://github.com/btravers/amqp-contract/blob/
|
|
558
|
+
Defined in: [packages/worker/src/handlers.ts:73](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/handlers.ts#L73)
|
|
559
559
|
|
|
560
560
|
Define a type-safe handler for a specific consumer in a contract.
|
|
561
561
|
|
|
@@ -647,7 +647,7 @@ const worker = await TypedAmqpWorker.create({
|
|
|
647
647
|
function defineHandlers<TContract>(contract, handlers): WorkerInferConsumerHandlers<TContract>;
|
|
648
648
|
```
|
|
649
649
|
|
|
650
|
-
Defined in: [packages/worker/src/handlers.ts:152](https://github.com/btravers/amqp-contract/blob/
|
|
650
|
+
Defined in: [packages/worker/src/handlers.ts:152](https://github.com/btravers/amqp-contract/blob/9351cdf40185977e98479881b5fc5e55897fdf7b/packages/worker/src/handlers.ts#L152)
|
|
651
651
|
|
|
652
652
|
Define multiple type-safe handlers for consumers in a contract.
|
|
653
653
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@amqp-contract/worker",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.1",
|
|
4
4
|
"description": "Worker utilities for consuming messages using amqp-contract",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"amqp",
|
|
@@ -44,8 +44,8 @@
|
|
|
44
44
|
"dependencies": {
|
|
45
45
|
"@standard-schema/spec": "1.1.0",
|
|
46
46
|
"@swan-io/boxed": "3.2.1",
|
|
47
|
-
"@amqp-contract/
|
|
48
|
-
"@amqp-contract/
|
|
47
|
+
"@amqp-contract/core": "0.3.1",
|
|
48
|
+
"@amqp-contract/contract": "0.3.1"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
51
|
"@types/amqplib": "0.10.8",
|
|
@@ -54,13 +54,13 @@
|
|
|
54
54
|
"amqp-connection-manager": "5.0.0",
|
|
55
55
|
"amqplib": "0.10.9",
|
|
56
56
|
"tsdown": "0.18.2",
|
|
57
|
-
"typedoc": "0.28.
|
|
57
|
+
"typedoc": "0.28.15",
|
|
58
58
|
"typedoc-plugin-markdown": "4.9.0",
|
|
59
59
|
"typescript": "5.9.3",
|
|
60
60
|
"vitest": "4.0.16",
|
|
61
61
|
"zod": "4.2.1",
|
|
62
|
-
"@amqp-contract/client": "0.3.
|
|
63
|
-
"@amqp-contract/testing": "0.3.
|
|
62
|
+
"@amqp-contract/client": "0.3.1",
|
|
63
|
+
"@amqp-contract/testing": "0.3.1",
|
|
64
64
|
"@amqp-contract/tsconfig": "0.0.0",
|
|
65
65
|
"@amqp-contract/typedoc": "0.0.1"
|
|
66
66
|
},
|