@amqp-contract/core 0.19.0 → 0.21.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 CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  ### AmqpClient
10
10
 
11
- Defined in: [packages/core/src/amqp-client.ts:84](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L84)
11
+ Defined in: [packages/core/src/amqp-client.ts:100](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L100)
12
12
 
13
13
  AMQP client that manages connections and channels with automatic topology setup.
14
14
 
@@ -46,7 +46,7 @@ await client.close().resultToPromise();
46
46
  new AmqpClient(contract, options): AmqpClient;
47
47
  ```
48
48
 
49
- Defined in: [packages/core/src/amqp-client.ts:101](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L101)
49
+ Defined in: [packages/core/src/amqp-client.ts:117](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L117)
50
50
 
51
51
  Create a new AMQP client instance.
52
52
 
@@ -74,7 +74,7 @@ The client will automatically:
74
74
  ack(msg, allUpTo?): void;
75
75
  ```
76
76
 
77
- Defined in: [packages/core/src/amqp-client.ts:219](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L219)
77
+ Defined in: [packages/core/src/amqp-client.ts:254](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L254)
78
78
 
79
79
  Acknowledge a message.
80
80
 
@@ -95,7 +95,7 @@ Acknowledge a message.
95
95
  addSetup(setup): void;
96
96
  ```
97
97
 
98
- Defined in: [packages/core/src/amqp-client.ts:241](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L241)
98
+ Defined in: [packages/core/src/amqp-client.ts:276](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L276)
99
99
 
100
100
  Add a setup function to be called when the channel is created or reconnected.
101
101
 
@@ -117,7 +117,7 @@ This is useful for setting up channel-level configuration like prefetch.
117
117
  cancel(consumerTag): Future<Result<void, TechnicalError>>;
118
118
  ```
119
119
 
120
- Defined in: [packages/core/src/amqp-client.ts:207](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L207)
120
+ Defined in: [packages/core/src/amqp-client.ts:242](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L242)
121
121
 
122
122
  Cancel a consumer by its consumer tag.
123
123
 
@@ -139,7 +139,7 @@ A Future that resolves when the consumer is cancelled
139
139
  close(): Future<Result<void, TechnicalError>>;
140
140
  ```
141
141
 
142
- Defined in: [packages/core/src/amqp-client.ts:270](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L270)
142
+ Defined in: [packages/core/src/amqp-client.ts:305](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L305)
143
143
 
144
144
  Close the channel and release the connection reference.
145
145
 
@@ -163,7 +163,7 @@ consume(
163
163
  options?): Future<Result<string, TechnicalError>>;
164
164
  ```
165
165
 
166
- Defined in: [packages/core/src/amqp-client.ts:191](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L191)
166
+ Defined in: [packages/core/src/amqp-client.ts:226](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L226)
167
167
 
168
168
  Start consuming messages from a queue.
169
169
 
@@ -173,7 +173,7 @@ Start consuming messages from a queue.
173
173
  | ------ | ------ | ------ |
174
174
  | `queue` | `string` | The queue name |
175
175
  | `callback` | [`ConsumeCallback`](#consumecallback) | The callback to invoke for each message |
176
- | `options?` | `Consume` | Optional consume options |
176
+ | `options?` | [`ConsumerOptions`](#consumeroptions) | Optional consume options |
177
177
 
178
178
  ###### Returns
179
179
 
@@ -187,7 +187,7 @@ A Future with `Result<string>` - the consumer tag
187
187
  getConnection(): IAmqpConnectionManager;
188
188
  ```
189
189
 
190
- Defined in: [packages/core/src/amqp-client.ts:148](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L148)
190
+ Defined in: [packages/core/src/amqp-client.ts:165](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L165)
191
191
 
192
192
  Get the underlying connection manager
193
193
 
@@ -210,7 +210,7 @@ nack(
210
210
  requeue?): void;
211
211
  ```
212
212
 
213
- Defined in: [packages/core/src/amqp-client.ts:230](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L230)
213
+ Defined in: [packages/core/src/amqp-client.ts:265](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L265)
214
214
 
215
215
  Negative acknowledge a message.
216
216
 
@@ -232,7 +232,7 @@ Negative acknowledge a message.
232
232
  on(event, listener): void;
233
233
  ```
234
234
 
235
- Defined in: [packages/core/src/amqp-client.ts:256](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L256)
235
+ Defined in: [packages/core/src/amqp-client.ts:291](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L291)
236
236
 
237
237
  Register an event listener on the channel wrapper.
238
238
 
@@ -262,7 +262,7 @@ publish(
262
262
  options?): Future<Result<boolean, TechnicalError>>;
263
263
  ```
264
264
 
265
- Defined in: [packages/core/src/amqp-client.ts:172](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L172)
265
+ Defined in: [packages/core/src/amqp-client.ts:189](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L189)
266
266
 
267
267
  Publish a message to an exchange.
268
268
 
@@ -273,7 +273,34 @@ Publish a message to an exchange.
273
273
  | `exchange` | `string` | The exchange name |
274
274
  | `routingKey` | `string` | The routing key |
275
275
  | `content` | `unknown` | The message content (will be JSON serialized if json: true) |
276
- | `options?` | `Publish` | Optional publish options |
276
+ | `options?` | [`PublishOptions`](#publishoptions) | Optional publish options |
277
+
278
+ ###### Returns
279
+
280
+ `Future`&lt;`Result`&lt;`boolean`, [`TechnicalError`](#technicalerror)&gt;&gt;
281
+
282
+ A Future with `Result<boolean>` - true if message was sent, false if channel buffer is full
283
+
284
+ ##### sendToQueue()
285
+
286
+ ```ts
287
+ sendToQueue(
288
+ queue,
289
+ content,
290
+ options?): Future<Result<boolean, TechnicalError>>;
291
+ ```
292
+
293
+ Defined in: [packages/core/src/amqp-client.ts:208](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L208)
294
+
295
+ Publish a message directly to a queue.
296
+
297
+ ###### Parameters
298
+
299
+ | Parameter | Type | Description |
300
+ | ------ | ------ | ------ |
301
+ | `queue` | `string` | The queue name |
302
+ | `content` | `unknown` | The message content (will be JSON serialized if json: true) |
303
+ | `options?` | [`PublishOptions`](#publishoptions) | Optional publish options |
277
304
 
278
305
  ###### Returns
279
306
 
@@ -287,7 +314,7 @@ A Future with `Result<boolean>` - true if message was sent, false if channel buf
287
314
  waitForConnect(): Future<Result<void, TechnicalError>>;
288
315
  ```
289
316
 
290
- Defined in: [packages/core/src/amqp-client.ts:157](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L157)
317
+ Defined in: [packages/core/src/amqp-client.ts:174](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L174)
291
318
 
292
319
  Wait for the channel to be connected and ready.
293
320
 
@@ -301,7 +328,7 @@ A Future that resolves when the channel is connected
301
328
 
302
329
  ### ConnectionManagerSingleton
303
330
 
304
- Defined in: [packages/core/src/connection-manager.ts:23](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/connection-manager.ts#L23)
331
+ Defined in: [packages/core/src/connection-manager.ts:23](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/connection-manager.ts#L23)
305
332
 
306
333
  Connection manager singleton for sharing AMQP connections across clients.
307
334
 
@@ -327,7 +354,7 @@ await manager.releaseConnection(['amqp://localhost']);
327
354
  getConnection(urls, connectionOptions?): IAmqpConnectionManager;
328
355
  ```
329
356
 
330
- Defined in: [packages/core/src/connection-manager.ts:52](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/connection-manager.ts#L52)
357
+ Defined in: [packages/core/src/connection-manager.ts:52](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/connection-manager.ts#L52)
331
358
 
332
359
  Get or create a connection for the given URLs and options.
333
360
 
@@ -353,7 +380,7 @@ The AMQP connection manager instance
353
380
  releaseConnection(urls, connectionOptions?): Promise<void>;
354
381
  ```
355
382
 
356
- Defined in: [packages/core/src/connection-manager.ts:81](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/connection-manager.ts#L81)
383
+ Defined in: [packages/core/src/connection-manager.ts:81](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/connection-manager.ts#L81)
357
384
 
358
385
  Release a connection reference.
359
386
 
@@ -379,7 +406,7 @@ A promise that resolves when the connection is released (and closed if necessary
379
406
  static getInstance(): ConnectionManagerSingleton;
380
407
  ```
381
408
 
382
- Defined in: [packages/core/src/connection-manager.ts:35](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/connection-manager.ts#L35)
409
+ Defined in: [packages/core/src/connection-manager.ts:35](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/connection-manager.ts#L35)
383
410
 
384
411
  Get the singleton instance of the connection manager.
385
412
 
@@ -393,7 +420,7 @@ The singleton instance
393
420
 
394
421
  ### MessageValidationError
395
422
 
396
- Defined in: [packages/core/src/errors.ts:33](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/errors.ts#L33)
423
+ Defined in: [packages/core/src/errors.ts:33](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/errors.ts#L33)
397
424
 
398
425
  Error thrown when message validation fails (payload or headers).
399
426
 
@@ -420,7 +447,7 @@ The validation issues from the Standard Schema validation
420
447
  new MessageValidationError(source, issues): MessageValidationError;
421
448
  ```
422
449
 
423
- Defined in: [packages/core/src/errors.ts:34](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/errors.ts#L34)
450
+ Defined in: [packages/core/src/errors.ts:34](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/errors.ts#L34)
424
451
 
425
452
  ###### Parameters
426
453
 
@@ -443,23 +470,94 @@ Error.constructor
443
470
 
444
471
  | Property | Modifier | Type | Description | Inherited from | Defined in |
445
472
  | ------ | ------ | ------ | ------ | ------ | ------ |
446
- | <a id="cause"></a> `cause?` | `public` | `unknown` | - | `Error.cause` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26 |
447
- | <a id="issues"></a> `issues` | `readonly` | `unknown` | - | - | [packages/core/src/errors.ts:36](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/errors.ts#L36) |
448
- | <a id="message"></a> `message` | `public` | `string` | - | `Error.message` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077 |
449
- | <a id="name"></a> `name` | `public` | `string` | - | `Error.name` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 |
450
- | <a id="source"></a> `source` | `readonly` | `string` | - | - | [packages/core/src/errors.ts:35](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/errors.ts#L35) |
451
- | <a id="stack"></a> `stack?` | `public` | `string` | - | `Error.stack` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078 |
452
- | <a id="stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | node\_modules/.pnpm/@types+node@25.2.3/node\_modules/@types/node/globals.d.ts:67 |
473
+ | <a id="cause"></a> `cause?` | `public` | `unknown` | - | `Error.cause` | node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24 |
474
+ | <a id="issues"></a> `issues` | `readonly` | `unknown` | - | - | [packages/core/src/errors.ts:36](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/errors.ts#L36) |
475
+ | <a id="message"></a> `message` | `public` | `string` | - | `Error.message` | node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1075 |
476
+ | <a id="name"></a> `name` | `public` | `string` | - | `Error.name` | node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1074 |
477
+ | <a id="source"></a> `source` | `readonly` | `string` | - | - | [packages/core/src/errors.ts:35](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/errors.ts#L35) |
478
+ | <a id="stack"></a> `stack?` | `public` | `string` | - | `Error.stack` | node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 |
479
+ | <a id="stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:67 |
453
480
 
454
481
  #### Methods
455
482
 
456
483
  ##### captureStackTrace()
457
484
 
485
+ ###### Call Signature
486
+
458
487
  ```ts
459
488
  static captureStackTrace(targetObject, constructorOpt?): void;
460
489
  ```
461
490
 
462
- Defined in: node\_modules/.pnpm/@types+node@25.2.3/node\_modules/@types/node/globals.d.ts:51
491
+ Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:51
492
+
493
+ Creates a `.stack` property on `targetObject`, which when accessed returns
494
+ a string representing the location in the code at which
495
+ `Error.captureStackTrace()` was called.
496
+
497
+ ```js
498
+ const myObject = {};
499
+ Error.captureStackTrace(myObject);
500
+ myObject.stack; // Similar to `new Error().stack`
501
+ ```
502
+
503
+ The first line of the trace will be prefixed with
504
+ `${myObject.name}: ${myObject.message}`.
505
+
506
+ The optional `constructorOpt` argument accepts a function. If given, all frames
507
+ above `constructorOpt`, including `constructorOpt`, will be omitted from the
508
+ generated stack trace.
509
+
510
+ The `constructorOpt` argument is useful for hiding implementation
511
+ details of error generation from the user. For instance:
512
+
513
+ ```js
514
+ function a() {
515
+ b();
516
+ }
517
+
518
+ function b() {
519
+ c();
520
+ }
521
+
522
+ function c() {
523
+ // Create an error without stack trace to avoid calculating the stack trace twice.
524
+ const { stackTraceLimit } = Error;
525
+ Error.stackTraceLimit = 0;
526
+ const error = new Error();
527
+ Error.stackTraceLimit = stackTraceLimit;
528
+
529
+ // Capture the stack trace above function b
530
+ Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
531
+ throw error;
532
+ }
533
+
534
+ a();
535
+ ```
536
+
537
+ ###### Parameters
538
+
539
+ | Parameter | Type |
540
+ | ------ | ------ |
541
+ | `targetObject` | `object` |
542
+ | `constructorOpt?` | `Function` |
543
+
544
+ ###### Returns
545
+
546
+ `void`
547
+
548
+ ###### Inherited from
549
+
550
+ ```ts
551
+ Error.captureStackTrace
552
+ ```
553
+
554
+ ###### Call Signature
555
+
556
+ ```ts
557
+ static captureStackTrace(targetObject, constructorOpt?): void;
558
+ ```
559
+
560
+ Defined in: node\_modules/.pnpm/@types+node@24.12.2/node\_modules/@types/node/globals.d.ts:52
463
561
 
464
562
  Creates a `.stack` property on `targetObject`, which when accessed returns
465
563
  a string representing the location in the code at which
@@ -524,11 +622,42 @@ Error.captureStackTrace
524
622
 
525
623
  ##### prepareStackTrace()
526
624
 
625
+ ###### Call Signature
626
+
527
627
  ```ts
528
628
  static prepareStackTrace(err, stackTraces): any;
529
629
  ```
530
630
 
531
- Defined in: node\_modules/.pnpm/@types+node@25.2.3/node\_modules/@types/node/globals.d.ts:55
631
+ Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:55
632
+
633
+ ###### Parameters
634
+
635
+ | Parameter | Type |
636
+ | ------ | ------ |
637
+ | `err` | `Error` |
638
+ | `stackTraces` | `CallSite`[] |
639
+
640
+ ###### Returns
641
+
642
+ `any`
643
+
644
+ ###### See
645
+
646
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
647
+
648
+ ###### Inherited from
649
+
650
+ ```ts
651
+ Error.prepareStackTrace
652
+ ```
653
+
654
+ ###### Call Signature
655
+
656
+ ```ts
657
+ static prepareStackTrace(err, stackTraces): any;
658
+ ```
659
+
660
+ Defined in: node\_modules/.pnpm/@types+node@24.12.2/node\_modules/@types/node/globals.d.ts:56
532
661
 
533
662
  ###### Parameters
534
663
 
@@ -555,7 +684,7 @@ Error.prepareStackTrace
555
684
 
556
685
  ### TechnicalError
557
686
 
558
- Defined in: [packages/core/src/errors.ts:7](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/errors.ts#L7)
687
+ Defined in: [packages/core/src/errors.ts:7](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/errors.ts#L7)
559
688
 
560
689
  Error for technical/runtime failures that cannot be prevented by TypeScript.
561
690
 
@@ -574,7 +703,7 @@ and other runtime errors. This error is shared across core, worker, and client p
574
703
  new TechnicalError(message, cause?): TechnicalError;
575
704
  ```
576
705
 
577
- Defined in: [packages/core/src/errors.ts:8](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/errors.ts#L8)
706
+ Defined in: [packages/core/src/errors.ts:8](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/errors.ts#L8)
578
707
 
579
708
  ###### Parameters
580
709
 
@@ -597,21 +726,92 @@ Error.constructor
597
726
 
598
727
  | Property | Modifier | Type | Description | Inherited from | Defined in |
599
728
  | ------ | ------ | ------ | ------ | ------ | ------ |
600
- | <a id="cause-1"></a> `cause?` | `readonly` | `unknown` | - | `Error.cause` | [packages/core/src/errors.ts:10](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/errors.ts#L10) |
601
- | <a id="message-1"></a> `message` | `public` | `string` | - | `Error.message` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077 |
602
- | <a id="name-1"></a> `name` | `public` | `string` | - | `Error.name` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 |
603
- | <a id="stack-1"></a> `stack?` | `public` | `string` | - | `Error.stack` | node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078 |
604
- | <a id="stacktracelimit-1"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | node\_modules/.pnpm/@types+node@25.2.3/node\_modules/@types/node/globals.d.ts:67 |
729
+ | <a id="cause-1"></a> `cause?` | `readonly` | `unknown` | - | `Error.cause` | [packages/core/src/errors.ts:10](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/errors.ts#L10) |
730
+ | <a id="message-1"></a> `message` | `public` | `string` | - | `Error.message` | node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1075 |
731
+ | <a id="name-1"></a> `name` | `public` | `string` | - | `Error.name` | node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1074 |
732
+ | <a id="stack-1"></a> `stack?` | `public` | `string` | - | `Error.stack` | node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1076 |
733
+ | <a id="stacktracelimit-1"></a> `stackTraceLimit` | `static` | `number` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | `Error.stackTraceLimit` | node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:67 |
605
734
 
606
735
  #### Methods
607
736
 
608
737
  ##### captureStackTrace()
609
738
 
739
+ ###### Call Signature
740
+
610
741
  ```ts
611
742
  static captureStackTrace(targetObject, constructorOpt?): void;
612
743
  ```
613
744
 
614
- Defined in: node\_modules/.pnpm/@types+node@25.2.3/node\_modules/@types/node/globals.d.ts:51
745
+ Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:51
746
+
747
+ Creates a `.stack` property on `targetObject`, which when accessed returns
748
+ a string representing the location in the code at which
749
+ `Error.captureStackTrace()` was called.
750
+
751
+ ```js
752
+ const myObject = {};
753
+ Error.captureStackTrace(myObject);
754
+ myObject.stack; // Similar to `new Error().stack`
755
+ ```
756
+
757
+ The first line of the trace will be prefixed with
758
+ `${myObject.name}: ${myObject.message}`.
759
+
760
+ The optional `constructorOpt` argument accepts a function. If given, all frames
761
+ above `constructorOpt`, including `constructorOpt`, will be omitted from the
762
+ generated stack trace.
763
+
764
+ The `constructorOpt` argument is useful for hiding implementation
765
+ details of error generation from the user. For instance:
766
+
767
+ ```js
768
+ function a() {
769
+ b();
770
+ }
771
+
772
+ function b() {
773
+ c();
774
+ }
775
+
776
+ function c() {
777
+ // Create an error without stack trace to avoid calculating the stack trace twice.
778
+ const { stackTraceLimit } = Error;
779
+ Error.stackTraceLimit = 0;
780
+ const error = new Error();
781
+ Error.stackTraceLimit = stackTraceLimit;
782
+
783
+ // Capture the stack trace above function b
784
+ Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
785
+ throw error;
786
+ }
787
+
788
+ a();
789
+ ```
790
+
791
+ ###### Parameters
792
+
793
+ | Parameter | Type |
794
+ | ------ | ------ |
795
+ | `targetObject` | `object` |
796
+ | `constructorOpt?` | `Function` |
797
+
798
+ ###### Returns
799
+
800
+ `void`
801
+
802
+ ###### Inherited from
803
+
804
+ ```ts
805
+ Error.captureStackTrace
806
+ ```
807
+
808
+ ###### Call Signature
809
+
810
+ ```ts
811
+ static captureStackTrace(targetObject, constructorOpt?): void;
812
+ ```
813
+
814
+ Defined in: node\_modules/.pnpm/@types+node@24.12.2/node\_modules/@types/node/globals.d.ts:52
615
815
 
616
816
  Creates a `.stack` property on `targetObject`, which when accessed returns
617
817
  a string representing the location in the code at which
@@ -676,11 +876,42 @@ Error.captureStackTrace
676
876
 
677
877
  ##### prepareStackTrace()
678
878
 
879
+ ###### Call Signature
880
+
679
881
  ```ts
680
882
  static prepareStackTrace(err, stackTraces): any;
681
883
  ```
682
884
 
683
- Defined in: node\_modules/.pnpm/@types+node@25.2.3/node\_modules/@types/node/globals.d.ts:55
885
+ Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:55
886
+
887
+ ###### Parameters
888
+
889
+ | Parameter | Type |
890
+ | ------ | ------ |
891
+ | `err` | `Error` |
892
+ | `stackTraces` | `CallSite`[] |
893
+
894
+ ###### Returns
895
+
896
+ `any`
897
+
898
+ ###### See
899
+
900
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
901
+
902
+ ###### Inherited from
903
+
904
+ ```ts
905
+ Error.prepareStackTrace
906
+ ```
907
+
908
+ ###### Call Signature
909
+
910
+ ```ts
911
+ static prepareStackTrace(err, stackTraces): any;
912
+ ```
913
+
914
+ Defined in: node\_modules/.pnpm/@types+node@24.12.2/node\_modules/@types/node/globals.d.ts:56
684
915
 
685
916
  ###### Parameters
686
917
 
@@ -711,7 +942,7 @@ Error.prepareStackTrace
711
942
  type AmqpClientOptions = object;
712
943
  ```
713
944
 
714
- Defined in: [packages/core/src/amqp-client.ts:45](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L45)
945
+ Defined in: [packages/core/src/amqp-client.ts:45](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L45)
715
946
 
716
947
  Options for creating an AMQP client.
717
948
 
@@ -719,19 +950,19 @@ Options for creating an AMQP client.
719
950
 
720
951
  | Property | Type | Description | Defined in |
721
952
  | ------ | ------ | ------ | ------ |
722
- | <a id="channeloptions"></a> `channelOptions?` | `Partial`&lt;`CreateChannelOpts`&gt; | Optional channel configuration options. | [packages/core/src/amqp-client.ts:48](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L48) |
723
- | <a id="connectionoptions"></a> `connectionOptions?` | `AmqpConnectionManagerOptions` | Optional connection configuration (heartbeat, reconnect settings, etc.). | [packages/core/src/amqp-client.ts:47](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L47) |
724
- | <a id="urls"></a> `urls` | `ConnectionUrl`[] | AMQP broker URL(s). Multiple URLs provide failover support. | [packages/core/src/amqp-client.ts:46](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L46) |
953
+ | <a id="channeloptions"></a> `channelOptions?` | `Partial`&lt;`CreateChannelOpts`&gt; | Optional channel configuration options. | [packages/core/src/amqp-client.ts:48](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L48) |
954
+ | <a id="connectionoptions"></a> `connectionOptions?` | `AmqpConnectionManagerOptions` | Optional connection configuration (heartbeat, reconnect settings, etc.). | [packages/core/src/amqp-client.ts:47](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L47) |
955
+ | <a id="urls"></a> `urls` | `ConnectionUrl`[] | AMQP broker URL(s). Multiple URLs provide failover support. | [packages/core/src/amqp-client.ts:46](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L46) |
725
956
 
726
957
  ***
727
958
 
728
- ### ConsumeCallback()
959
+ ### ConsumeCallback
729
960
 
730
961
  ```ts
731
962
  type ConsumeCallback = (msg) => void | Promise<void>;
732
963
  ```
733
964
 
734
- Defined in: [packages/core/src/amqp-client.ts:54](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/amqp-client.ts#L54)
965
+ Defined in: [packages/core/src/amqp-client.ts:54](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L54)
735
966
 
736
967
  Callback type for consuming messages.
737
968
 
@@ -747,13 +978,31 @@ Callback type for consuming messages.
747
978
 
748
979
  ***
749
980
 
981
+ ### ConsumerOptions
982
+
983
+ ```ts
984
+ type ConsumerOptions = Options.Consume & object;
985
+ ```
986
+
987
+ Defined in: [packages/core/src/amqp-client.ts:67](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L67)
988
+
989
+ Consume options that extend amqplib's Options.Consume with optional prefetch support.
990
+
991
+ #### Type Declaration
992
+
993
+ | Name | Type | Description | Defined in |
994
+ | ------ | ------ | ------ | ------ |
995
+ | `prefetch?` | `number` | Number of messages to prefetch | [packages/core/src/amqp-client.ts:69](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L69) |
996
+
997
+ ***
998
+
750
999
  ### Logger
751
1000
 
752
1001
  ```ts
753
1002
  type Logger = object;
754
1003
  ```
755
1004
 
756
- Defined in: [packages/core/src/logger.ts:30](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/logger.ts#L30)
1005
+ Defined in: [packages/core/src/logger.ts:30](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/logger.ts#L30)
757
1006
 
758
1007
  Logger interface for amqp-contract packages.
759
1008
 
@@ -780,7 +1029,7 @@ const logger: Logger = {
780
1029
  debug(message, context?): void;
781
1030
  ```
782
1031
 
783
- Defined in: [packages/core/src/logger.ts:36](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/logger.ts#L36)
1032
+ Defined in: [packages/core/src/logger.ts:36](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/logger.ts#L36)
784
1033
 
785
1034
  Log debug level messages
786
1035
 
@@ -801,7 +1050,7 @@ Log debug level messages
801
1050
  error(message, context?): void;
802
1051
  ```
803
1052
 
804
- Defined in: [packages/core/src/logger.ts:57](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/logger.ts#L57)
1053
+ Defined in: [packages/core/src/logger.ts:57](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/logger.ts#L57)
805
1054
 
806
1055
  Log error level messages
807
1056
 
@@ -822,7 +1071,7 @@ Log error level messages
822
1071
  info(message, context?): void;
823
1072
  ```
824
1073
 
825
- Defined in: [packages/core/src/logger.ts:43](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/logger.ts#L43)
1074
+ Defined in: [packages/core/src/logger.ts:43](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/logger.ts#L43)
826
1075
 
827
1076
  Log info level messages
828
1077
 
@@ -843,7 +1092,7 @@ Log info level messages
843
1092
  warn(message, context?): void;
844
1093
  ```
845
1094
 
846
- Defined in: [packages/core/src/logger.ts:50](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/logger.ts#L50)
1095
+ Defined in: [packages/core/src/logger.ts:50](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/logger.ts#L50)
847
1096
 
848
1097
  Log warning level messages
849
1098
 
@@ -866,7 +1115,7 @@ Log warning level messages
866
1115
  type LoggerContext = Record<string, unknown> & object;
867
1116
  ```
868
1117
 
869
- Defined in: [packages/core/src/logger.ts:9](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/logger.ts#L9)
1118
+ Defined in: [packages/core/src/logger.ts:9](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/logger.ts#L9)
870
1119
 
871
1120
  Context object for logger methods.
872
1121
 
@@ -877,7 +1126,25 @@ for common logging context properties.
877
1126
 
878
1127
  | Name | Type | Defined in |
879
1128
  | ------ | ------ | ------ |
880
- | `error?` | `unknown` | [packages/core/src/logger.ts:10](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/logger.ts#L10) |
1129
+ | `error?` | `unknown` | [packages/core/src/logger.ts:10](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/logger.ts#L10) |
1130
+
1131
+ ***
1132
+
1133
+ ### PublishOptions
1134
+
1135
+ ```ts
1136
+ type PublishOptions = Options.Publish & object;
1137
+ ```
1138
+
1139
+ Defined in: [packages/core/src/amqp-client.ts:59](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L59)
1140
+
1141
+ Publish options that extend amqplib's Options.Publish with optional timeout support.
1142
+
1143
+ #### Type Declaration
1144
+
1145
+ | Name | Type | Description | Defined in |
1146
+ | ------ | ------ | ------ | ------ |
1147
+ | `timeout?` | `number` | Message will be rejected after timeout ms | [packages/core/src/amqp-client.ts:61](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/amqp-client.ts#L61) |
881
1148
 
882
1149
  ***
883
1150
 
@@ -887,7 +1154,7 @@ for common logging context properties.
887
1154
  type TelemetryProvider = object;
888
1155
  ```
889
1156
 
890
- Defined in: [packages/core/src/telemetry.ts:53](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L53)
1157
+ Defined in: [packages/core/src/telemetry.ts:53](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L53)
891
1158
 
892
1159
  Telemetry provider for AMQP operations.
893
1160
  Uses lazy loading to gracefully handle cases where OpenTelemetry is not installed.
@@ -896,11 +1163,11 @@ Uses lazy loading to gracefully handle cases where OpenTelemetry is not installe
896
1163
 
897
1164
  | Property | Type | Description | Defined in |
898
1165
  | ------ | ------ | ------ | ------ |
899
- | <a id="getconsumecounter"></a> `getConsumeCounter` | () => `Counter` \| `undefined` | Get a counter for messages consumed. Returns undefined if OpenTelemetry is not available. | [packages/core/src/telemetry.ts:70](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L70) |
900
- | <a id="getconsumelatencyhistogram"></a> `getConsumeLatencyHistogram` | () => `Histogram` \| `undefined` | Get a histogram for consume/process latency. Returns undefined if OpenTelemetry is not available. | [packages/core/src/telemetry.ts:82](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L82) |
901
- | <a id="getpublishcounter"></a> `getPublishCounter` | () => `Counter` \| `undefined` | Get a counter for messages published. Returns undefined if OpenTelemetry is not available. | [packages/core/src/telemetry.ts:64](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L64) |
902
- | <a id="getpublishlatencyhistogram"></a> `getPublishLatencyHistogram` | () => `Histogram` \| `undefined` | Get a histogram for publish latency. Returns undefined if OpenTelemetry is not available. | [packages/core/src/telemetry.ts:76](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L76) |
903
- | <a id="gettracer"></a> `getTracer` | () => `Tracer` \| `undefined` | Get a tracer instance for creating spans. Returns undefined if OpenTelemetry is not available. | [packages/core/src/telemetry.ts:58](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L58) |
1166
+ | <a id="getconsumecounter"></a> `getConsumeCounter` | () => `Counter` \| `undefined` | Get a counter for messages consumed. Returns undefined if OpenTelemetry is not available. | [packages/core/src/telemetry.ts:70](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L70) |
1167
+ | <a id="getconsumelatencyhistogram"></a> `getConsumeLatencyHistogram` | () => `Histogram` \| `undefined` | Get a histogram for consume/process latency. Returns undefined if OpenTelemetry is not available. | [packages/core/src/telemetry.ts:82](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L82) |
1168
+ | <a id="getpublishcounter"></a> `getPublishCounter` | () => `Counter` \| `undefined` | Get a counter for messages published. Returns undefined if OpenTelemetry is not available. | [packages/core/src/telemetry.ts:64](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L64) |
1169
+ | <a id="getpublishlatencyhistogram"></a> `getPublishLatencyHistogram` | () => `Histogram` \| `undefined` | Get a histogram for publish latency. Returns undefined if OpenTelemetry is not available. | [packages/core/src/telemetry.ts:76](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L76) |
1170
+ | <a id="gettracer"></a> `getTracer` | () => `Tracer` \| `undefined` | Get a tracer instance for creating spans. Returns undefined if OpenTelemetry is not available. | [packages/core/src/telemetry.ts:58](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L58) |
904
1171
 
905
1172
  ## Variables
906
1173
 
@@ -910,7 +1177,7 @@ Uses lazy loading to gracefully handle cases where OpenTelemetry is not installe
910
1177
  const defaultTelemetryProvider: TelemetryProvider;
911
1178
  ```
912
1179
 
913
- Defined in: [packages/core/src/telemetry.ts:194](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L194)
1180
+ Defined in: [packages/core/src/telemetry.ts:194](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L194)
914
1181
 
915
1182
  Default telemetry provider that uses OpenTelemetry API if available.
916
1183
 
@@ -922,7 +1189,7 @@ Default telemetry provider that uses OpenTelemetry API if available.
922
1189
  const MessagingSemanticConventions: object;
923
1190
  ```
924
1191
 
925
- Defined in: [packages/core/src/telemetry.ts:25](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L25)
1192
+ Defined in: [packages/core/src/telemetry.ts:25](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L25)
926
1193
 
927
1194
  Semantic conventions for AMQP messaging following OpenTelemetry standards.
928
1195
 
@@ -930,20 +1197,20 @@ Semantic conventions for AMQP messaging following OpenTelemetry standards.
930
1197
 
931
1198
  | Name | Type | Default value | Defined in |
932
1199
  | ------ | ------ | ------ | ------ |
933
- | <a id="property-amqp_consumer_name"></a> `AMQP_CONSUMER_NAME` | `"amqp.consumer.name"` | `"amqp.consumer.name"` | [packages/core/src/telemetry.ts:36](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L36) |
934
- | <a id="property-amqp_publisher_name"></a> `AMQP_PUBLISHER_NAME` | `"amqp.publisher.name"` | `"amqp.publisher.name"` | [packages/core/src/telemetry.ts:35](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L35) |
935
- | <a id="property-error_type"></a> `ERROR_TYPE` | `"error.type"` | `"error.type"` | [packages/core/src/telemetry.ts:39](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L39) |
936
- | <a id="property-messaging_destination"></a> `MESSAGING_DESTINATION` | `"messaging.destination.name"` | `"messaging.destination.name"` | [packages/core/src/telemetry.ts:28](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L28) |
937
- | <a id="property-messaging_destination_kind"></a> `MESSAGING_DESTINATION_KIND` | `"messaging.destination.kind"` | `"messaging.destination.kind"` | [packages/core/src/telemetry.ts:29](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L29) |
938
- | <a id="property-messaging_destination_kind_exchange"></a> `MESSAGING_DESTINATION_KIND_EXCHANGE` | `"exchange"` | `"exchange"` | [packages/core/src/telemetry.ts:43](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L43) |
939
- | <a id="property-messaging_destination_kind_queue"></a> `MESSAGING_DESTINATION_KIND_QUEUE` | `"queue"` | `"queue"` | [packages/core/src/telemetry.ts:44](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L44) |
940
- | <a id="property-messaging_operation"></a> `MESSAGING_OPERATION` | `"messaging.operation"` | `"messaging.operation"` | [packages/core/src/telemetry.ts:30](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L30) |
941
- | <a id="property-messaging_operation_process"></a> `MESSAGING_OPERATION_PROCESS` | `"process"` | `"process"` | [packages/core/src/telemetry.ts:46](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L46) |
942
- | <a id="property-messaging_operation_publish"></a> `MESSAGING_OPERATION_PUBLISH` | `"publish"` | `"publish"` | [packages/core/src/telemetry.ts:45](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L45) |
943
- | <a id="property-messaging_rabbitmq_message_delivery_tag"></a> `MESSAGING_RABBITMQ_MESSAGE_DELIVERY_TAG` | `"messaging.rabbitmq.message.delivery_tag"` | `"messaging.rabbitmq.message.delivery_tag"` | [packages/core/src/telemetry.ts:34](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L34) |
944
- | <a id="property-messaging_rabbitmq_routing_key"></a> `MESSAGING_RABBITMQ_ROUTING_KEY` | `"messaging.rabbitmq.destination.routing_key"` | `"messaging.rabbitmq.destination.routing_key"` | [packages/core/src/telemetry.ts:33](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L33) |
945
- | <a id="property-messaging_system"></a> `MESSAGING_SYSTEM` | `"messaging.system"` | `"messaging.system"` | [packages/core/src/telemetry.ts:27](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L27) |
946
- | <a id="property-messaging_system_rabbitmq"></a> `MESSAGING_SYSTEM_RABBITMQ` | `"rabbitmq"` | `"rabbitmq"` | [packages/core/src/telemetry.ts:42](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L42) |
1200
+ | <a id="property-amqp_consumer_name"></a> `AMQP_CONSUMER_NAME` | `"amqp.consumer.name"` | `"amqp.consumer.name"` | [packages/core/src/telemetry.ts:36](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L36) |
1201
+ | <a id="property-amqp_publisher_name"></a> `AMQP_PUBLISHER_NAME` | `"amqp.publisher.name"` | `"amqp.publisher.name"` | [packages/core/src/telemetry.ts:35](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L35) |
1202
+ | <a id="property-error_type"></a> `ERROR_TYPE` | `"error.type"` | `"error.type"` | [packages/core/src/telemetry.ts:39](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L39) |
1203
+ | <a id="property-messaging_destination"></a> `MESSAGING_DESTINATION` | `"messaging.destination.name"` | `"messaging.destination.name"` | [packages/core/src/telemetry.ts:28](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L28) |
1204
+ | <a id="property-messaging_destination_kind"></a> `MESSAGING_DESTINATION_KIND` | `"messaging.destination.kind"` | `"messaging.destination.kind"` | [packages/core/src/telemetry.ts:29](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L29) |
1205
+ | <a id="property-messaging_destination_kind_exchange"></a> `MESSAGING_DESTINATION_KIND_EXCHANGE` | `"exchange"` | `"exchange"` | [packages/core/src/telemetry.ts:43](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L43) |
1206
+ | <a id="property-messaging_destination_kind_queue"></a> `MESSAGING_DESTINATION_KIND_QUEUE` | `"queue"` | `"queue"` | [packages/core/src/telemetry.ts:44](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L44) |
1207
+ | <a id="property-messaging_operation"></a> `MESSAGING_OPERATION` | `"messaging.operation"` | `"messaging.operation"` | [packages/core/src/telemetry.ts:30](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L30) |
1208
+ | <a id="property-messaging_operation_process"></a> `MESSAGING_OPERATION_PROCESS` | `"process"` | `"process"` | [packages/core/src/telemetry.ts:46](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L46) |
1209
+ | <a id="property-messaging_operation_publish"></a> `MESSAGING_OPERATION_PUBLISH` | `"publish"` | `"publish"` | [packages/core/src/telemetry.ts:45](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L45) |
1210
+ | <a id="property-messaging_rabbitmq_message_delivery_tag"></a> `MESSAGING_RABBITMQ_MESSAGE_DELIVERY_TAG` | `"messaging.rabbitmq.message.delivery_tag"` | `"messaging.rabbitmq.message.delivery_tag"` | [packages/core/src/telemetry.ts:34](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L34) |
1211
+ | <a id="property-messaging_rabbitmq_routing_key"></a> `MESSAGING_RABBITMQ_ROUTING_KEY` | `"messaging.rabbitmq.destination.routing_key"` | `"messaging.rabbitmq.destination.routing_key"` | [packages/core/src/telemetry.ts:33](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L33) |
1212
+ | <a id="property-messaging_system"></a> `MESSAGING_SYSTEM` | `"messaging.system"` | `"messaging.system"` | [packages/core/src/telemetry.ts:27](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L27) |
1213
+ | <a id="property-messaging_system_rabbitmq"></a> `MESSAGING_SYSTEM_RABBITMQ` | `"rabbitmq"` | `"rabbitmq"` | [packages/core/src/telemetry.ts:42](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L42) |
947
1214
 
948
1215
  #### See
949
1216
 
@@ -957,7 +1224,7 @@ https://opentelemetry.io/docs/specs/semconv/messaging/messaging-spans/
957
1224
  function endSpanError(span, error): void;
958
1225
  ```
959
1226
 
960
- Defined in: [packages/core/src/telemetry.ts:288](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L288)
1227
+ Defined in: [packages/core/src/telemetry.ts:288](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L288)
961
1228
 
962
1229
  End a span with error status.
963
1230
 
@@ -980,7 +1247,7 @@ End a span with error status.
980
1247
  function endSpanSuccess(span): void;
981
1248
  ```
982
1249
 
983
- Defined in: [packages/core/src/telemetry.ts:273](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L273)
1250
+ Defined in: [packages/core/src/telemetry.ts:273](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L273)
984
1251
 
985
1252
  End a span with success status.
986
1253
 
@@ -1007,7 +1274,7 @@ function recordConsumeMetric(
1007
1274
  durationMs): void;
1008
1275
  ```
1009
1276
 
1010
- Defined in: [packages/core/src/telemetry.ts:332](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L332)
1277
+ Defined in: [packages/core/src/telemetry.ts:332](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L332)
1011
1278
 
1012
1279
  Record a consume metric.
1013
1280
 
@@ -1038,7 +1305,7 @@ function recordPublishMetric(
1038
1305
  durationMs): void;
1039
1306
  ```
1040
1307
 
1041
- Defined in: [packages/core/src/telemetry.ts:305](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L305)
1308
+ Defined in: [packages/core/src/telemetry.ts:305](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L305)
1042
1309
 
1043
1310
  Record a publish metric.
1044
1311
 
@@ -1064,7 +1331,7 @@ Record a publish metric.
1064
1331
  function setupAmqpTopology(channel, contract): Promise<void>;
1065
1332
  ```
1066
1333
 
1067
- Defined in: [packages/core/src/setup.ts:26](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/setup.ts#L26)
1334
+ Defined in: [packages/core/src/setup.ts:26](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/setup.ts#L26)
1068
1335
 
1069
1336
  Setup AMQP topology (exchanges, queues, and bindings) from a contract definition.
1070
1337
 
@@ -1112,7 +1379,7 @@ function startConsumeSpan(
1112
1379
  attributes?): Span | undefined;
1113
1380
  ```
1114
1381
 
1115
- Defined in: [packages/core/src/telemetry.ts:241](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L241)
1382
+ Defined in: [packages/core/src/telemetry.ts:241](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L241)
1116
1383
 
1117
1384
  Create a span for a consume/process operation.
1118
1385
  Returns undefined if OpenTelemetry is not available.
@@ -1142,7 +1409,7 @@ function startPublishSpan(
1142
1409
  attributes?): Span | undefined;
1143
1410
  ```
1144
1411
 
1145
- Defined in: [packages/core/src/telemetry.ts:206](https://github.com/btravers/amqp-contract/blob/a5ff0e58db355e3410ea3b765884871c3b44c87d/packages/core/src/telemetry.ts#L206)
1412
+ Defined in: [packages/core/src/telemetry.ts:206](https://github.com/btravers/amqp-contract/blob/c4431c816689353f677718608623c58fd1757388/packages/core/src/telemetry.ts#L206)
1146
1413
 
1147
1414
  Create a span for a publish operation.
1148
1415
  Returns undefined if OpenTelemetry is not available.