Skip to content

docs(events-amqp): initialConnectMaxRetries — bounded initial connect + API regen #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
intech merged 1 commit into from
Jul 5, 2026
Merged

docs(events-amqp): initialConnectMaxRetries — bounded initial connect + API regen #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion en/api/@connectum/events-amqp/functions/AmqpAdapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

> **AmqpAdapter**(`options`): `EventAdapter`

Defined in: [packages/events-amqp/src/AmqpAdapter.ts:401](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/AmqpAdapter.ts#L401)
Defined in: [packages/events-amqp/src/AmqpAdapter.ts:442](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/AmqpAdapter.ts#L442)

Create an AMQP/RabbitMQ adapter for @connectum/events.

Expand Down
15 changes: 8 additions & 7 deletions en/api/@connectum/events-amqp/types/interfaces/AmqpAdapterOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ false

> `readonly` `optional` **lifecycle?**: [`AmqpLifecycleCallbacks`](AmqpLifecycleCallbacks.md)

Defined in: [packages/events-amqp/src/types.ts:196](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L196)
Defined in: [packages/events-amqp/src/types.ts:197](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L197)

Connection lifecycle callbacks. Connection errors are surfaced here —
not just logged.
Expand All @@ -124,7 +124,7 @@ Publisher options.

> `readonly` `optional` **publishTimeoutMs?**: `number`

Defined in: [packages/events-amqp/src/types.ts:206](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L206)
Defined in: [packages/events-amqp/src/types.ts:207](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L207)

Per-publish broker-outcome deadline in milliseconds. A publish whose
ack/nack/return/connection-loss outcome does not arrive in time
Expand Down Expand Up @@ -263,7 +263,7 @@ How topology is established:

> `readonly` `optional` **treatTopologyErrorAsFatal?**: `boolean`

Defined in: [packages/events-amqp/src/types.ts:190](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L190)
Defined in: [packages/events-amqp/src/types.ts:191](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L191)

Treat DETERMINISTIC topology drift during steady-state recovery as
fatal: stop the reconnect cycle instead of retrying forever against a
Expand Down Expand Up @@ -293,10 +293,11 @@ re-subscribe explicitly.

Scope: steady-state recovery only. Boot-time drift is the startup
probe's job — see [failFastOnInitialSetupError](#failfastoninitialsetuperror). Setting both
covers boot and steady state; the remaining gap — broker unreachable at
`connect()` time with drift surfacing before the first successful
connect — is covered by neither flag until the bounded initial phase
lands ([https://github.com/Connectum-Framework/connectum/issues/198](https://github.com/Connectum-Framework/connectum/issues/198)).
covers boot and steady state; the remaining window — broker unreachable
at `connect()` time with drift surfacing before the first successful
connect — is closed by
[AmqpRecoveryOptions.initialConnectMaxRetries](AmqpRecoveryOptions.md#initialconnectmaxretries) (since 1.3.0),
whose bounded phase surfaces those failures and rejects on exhaustion.

#### Default

Expand Down
12 changes: 6 additions & 6 deletions en/api/@connectum/events-amqp/types/interfaces/AmqpBindingDeclaration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@

# Interface: AmqpBindingDeclaration

Defined in: [packages/events-amqp/src/types.ts:266](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L266)
Defined in: [packages/events-amqp/src/types.ts:267](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L267)

## Properties

### arguments?

> `readonly` `optional` **arguments?**: `Record`\<`string`, `unknown`\>

Defined in: [packages/events-amqp/src/types.ts:274](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L274)
Defined in: [packages/events-amqp/src/types.ts:275](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L275)

***

### exchange?

> `readonly` `optional` **exchange?**: `string`

Defined in: [packages/events-amqp/src/types.ts:270](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L270)
Defined in: [packages/events-amqp/src/types.ts:271](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L271)

Destination exchange name (exchange-to-exchange binding).

Expand All @@ -28,7 +28,7 @@ Destination exchange name (exchange-to-exchange binding).

> `readonly` `optional` **queue?**: `string`

Defined in: [packages/events-amqp/src/types.ts:268](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L268)
Defined in: [packages/events-amqp/src/types.ts:269](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L269)

Destination queue name (queue binding) — mutually exclusive with `exchange`.

Expand All @@ -38,14 +38,14 @@ Destination queue name (queue binding) — mutually exclusive with `exchange`.

> `readonly` **routingKey**: `string`

Defined in: [packages/events-amqp/src/types.ts:273](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L273)
Defined in: [packages/events-amqp/src/types.ts:274](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L274)

***

### source

> `readonly` **source**: `string`

Defined in: [packages/events-amqp/src/types.ts:272](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L272)
Defined in: [packages/events-amqp/src/types.ts:273](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L273)

Source exchange.
6 changes: 3 additions & 3 deletions en/api/@connectum/events-amqp/types/interfaces/AmqpConsumerOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: AmqpConsumerOptions

Defined in: [packages/events-amqp/src/types.ts:478](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L478)
Defined in: [packages/events-amqp/src/types.ts:518](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L518)

Consumer options.

Expand All @@ -12,7 +12,7 @@ Consumer options.

> `readonly` `optional` **exclusive?**: `boolean`

Defined in: [packages/events-amqp/src/types.ts:492](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L492)
Defined in: [packages/events-amqp/src/types.ts:532](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L532)

Whether the consumer is exclusive to this connection.

Expand All @@ -28,7 +28,7 @@ false

> `readonly` `optional` **prefetch?**: `number`

Defined in: [packages/events-amqp/src/types.ts:485](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L485)
Defined in: [packages/events-amqp/src/types.ts:525](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L525)

Prefetch count (QoS) — how many unacknowledged messages
a consumer can have at a time.
Expand Down
12 changes: 6 additions & 6 deletions en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeDeclaration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

# Interface: AmqpExchangeDeclaration

Defined in: [packages/events-amqp/src/types.ts:248](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L248)
Defined in: [packages/events-amqp/src/types.ts:249](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L249)

## Properties

### arguments?

> `readonly` `optional` **arguments?**: `Record`\<`string`, `unknown`\>

Defined in: [packages/events-amqp/src/types.ts:254](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L254)
Defined in: [packages/events-amqp/src/types.ts:255](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L255)

Raw AMQP arguments passthrough.

Expand All @@ -20,28 +20,28 @@ Raw AMQP arguments passthrough.

> `readonly` `optional` **autoDelete?**: `boolean`

Defined in: [packages/events-amqp/src/types.ts:252](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L252)
Defined in: [packages/events-amqp/src/types.ts:253](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L253)

***

### durable?

> `readonly` `optional` **durable?**: `boolean`

Defined in: [packages/events-amqp/src/types.ts:251](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L251)
Defined in: [packages/events-amqp/src/types.ts:252](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L252)

***

### name

> `readonly` **name**: `string`

Defined in: [packages/events-amqp/src/types.ts:249](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L249)
Defined in: [packages/events-amqp/src/types.ts:250](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L250)

***

### type

> `readonly` **type**: `"headers"` \| `"topic"` \| `"direct"` \| `"fanout"`

Defined in: [packages/events-amqp/src/types.ts:250](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L250)
Defined in: [packages/events-amqp/src/types.ts:251](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L251)
6 changes: 3 additions & 3 deletions en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: AmqpExchangeOptions

Defined in: [packages/events-amqp/src/types.ts:427](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L427)
Defined in: [packages/events-amqp/src/types.ts:467](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L467)

Exchange assertion options.

Expand All @@ -12,7 +12,7 @@ Exchange assertion options.

> `readonly` `optional` **autoDelete?**: `boolean`

Defined in: [packages/events-amqp/src/types.ts:440](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L440)
Defined in: [packages/events-amqp/src/types.ts:480](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L480)

Whether the exchange is deleted when the last queue unbinds.

Expand All @@ -28,7 +28,7 @@ false

> `readonly` `optional` **durable?**: `boolean`

Defined in: [packages/events-amqp/src/types.ts:433](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L433)
Defined in: [packages/events-amqp/src/types.ts:473](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L473)

Whether the exchange should survive broker restarts.

Expand Down
19 changes: 10 additions & 9 deletions en/api/@connectum/events-amqp/types/interfaces/AmqpLifecycleCallbacks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: AmqpLifecycleCallbacks

Defined in: [packages/events-amqp/src/types.ts:371](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L371)
Defined in: [packages/events-amqp/src/types.ts:410](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L410)

Connection lifecycle callbacks.

Expand All @@ -16,7 +16,7 @@ deprecated since 1.3.0 (removal not before 2.0).

> `readonly` `optional` **onConnected?**: () => `void`

Defined in: [packages/events-amqp/src/types.ts:391](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L391)
Defined in: [packages/events-amqp/src/types.ts:430](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L430)

#### Returns

Expand All @@ -32,7 +32,7 @@ Since 1.3.0 — use [onLifecycle](#onlifecycle) (`type: "connected"`). Kept unti

> `readonly` `optional` **onDisconnected?**: (`cause`) => `void`

Defined in: [packages/events-amqp/src/types.ts:393](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L393)
Defined in: [packages/events-amqp/src/types.ts:432](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L432)

#### Parameters

Expand All @@ -54,7 +54,7 @@ Since 1.3.0 — use [onLifecycle](#onlifecycle) (`type: "disconnected"`). Kept u

> `readonly` `optional` **onLifecycle?**: (`event`) => `void`

Defined in: [packages/events-amqp/src/types.ts:389](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L389)
Defined in: [packages/events-amqp/src/types.ts:428](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L428)

Single discriminated-union lifecycle callback — the preferred surface.
Receives every [AmqpLifecycleEvent](../type-aliases/AmqpLifecycleEvent.md), including `blocked`/`unblocked`,
Expand Down Expand Up @@ -88,7 +88,7 @@ deterministic misconfiguration at boot.

> `readonly` `optional` **onReconnectFailed?**: (`cause`) => `void`

Defined in: [packages/events-amqp/src/types.ts:406](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L406)
Defined in: [packages/events-amqp/src/types.ts:445](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L445)

#### Parameters

Expand All @@ -110,7 +110,7 @@ Since 1.3.0 — use [onLifecycle](#onlifecycle) (`type: "reconnect-failed"`). Ke

> `readonly` `optional` **onReconnecting?**: (`info`) => `void`

Defined in: [packages/events-amqp/src/types.ts:404](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L404)
Defined in: [packages/events-amqp/src/types.ts:443](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L443)

A reconnect attempt has been scheduled. Fires exactly ONCE per scheduled
retry (amqplib's `reconnect-scheduled`). A failed attempt that also emits
Expand Down Expand Up @@ -149,11 +149,12 @@ Since 1.3.0 — use [onLifecycle](#onlifecycle) (`type: "reconnecting"`). Kept u

> `readonly` `optional` **onSetupFailed?**: (`error`, `ctx`) => `void`

Defined in: [packages/events-amqp/src/types.ts:421](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L421)
Defined in: [packages/events-amqp/src/types.ts:461](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L461)

A setup/topology failure occurred while (re)applying the declarative
topology — on the initial connect's validation probe (`ctx.initial: true`,
`ctx.attempt: 0`) and/or on a reconnect whose topology re-assert fails
topology — during the startup window (`ctx.initial: true`; `ctx.attempt`
is 0 on the probe, or the 0-based attempt index in the bounded initial
phase) and/or on a reconnect whose topology re-assert fails
(`ctx.initial: false`, `ctx.attempt` ≥ 1).

This surfaces deterministic configuration drift (e.g. a missing queue in
Expand Down
10 changes: 5 additions & 5 deletions en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: AmqpPublisherOptions

Defined in: [packages/events-amqp/src/types.ts:498](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L498)
Defined in: [packages/events-amqp/src/types.ts:538](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L538)

Publisher options.

Expand All @@ -12,7 +12,7 @@ Publisher options.

> `readonly` `optional` **correlationHeader?**: `boolean`

Defined in: [packages/events-amqp/src/types.ts:527](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L527)
Defined in: [packages/events-amqp/src/types.ts:567](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L567)

How `basic.return` frames are correlated to publishes when
`mandatory: true`. The return frame carries no deliveryTag, so:
Expand All @@ -36,7 +36,7 @@ true

> `readonly` `optional` **externalContract?**: `boolean`

Defined in: [packages/events-amqp/src/types.ts:556](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L556)
Defined in: [packages/events-amqp/src/types.ts:596](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L596)

Publish against an EXTERNAL (non-EventBus) message contract: suppress the
EventBus envelope so the wire frame carries ONLY contract-specified
Expand Down Expand Up @@ -74,7 +74,7 @@ false

> `readonly` `optional` **mandatory?**: `boolean`

Defined in: [packages/events-amqp/src/types.ts:512](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L512)
Defined in: [packages/events-amqp/src/types.ts:552](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L552)

Whether the message should be returned if it cannot be routed.
Unroutable messages reject the publish with `AmqpUnroutableError`.
Expand All @@ -91,7 +91,7 @@ false

> `readonly` `optional` **persistent?**: `boolean`

Defined in: [packages/events-amqp/src/types.ts:504](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L504)
Defined in: [packages/events-amqp/src/types.ts:544](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L544)

Whether messages should be persisted to disk (deliveryMode=2).

Expand Down
12 changes: 6 additions & 6 deletions en/api/@connectum/events-amqp/types/interfaces/AmqpQueueDeclaration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

# Interface: AmqpQueueDeclaration

Defined in: [packages/events-amqp/src/types.ts:257](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L257)
Defined in: [packages/events-amqp/src/types.ts:258](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L258)

## Properties

### arguments?

> `readonly` `optional` **arguments?**: `Record`\<`string`, `unknown`\>

Defined in: [packages/events-amqp/src/types.ts:263](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L263)
Defined in: [packages/events-amqp/src/types.ts:264](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L264)

Raw AMQP arguments passthrough (e.g. x-dead-letter-exchange).

Expand All @@ -20,28 +20,28 @@ Raw AMQP arguments passthrough (e.g. x-dead-letter-exchange).

> `readonly` `optional` **autoDelete?**: `boolean`

Defined in: [packages/events-amqp/src/types.ts:260](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L260)
Defined in: [packages/events-amqp/src/types.ts:261](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L261)

***

### durable?

> `readonly` `optional` **durable?**: `boolean`

Defined in: [packages/events-amqp/src/types.ts:259](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L259)
Defined in: [packages/events-amqp/src/types.ts:260](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L260)

***

### exclusive?

> `readonly` `optional` **exclusive?**: `boolean`

Defined in: [packages/events-amqp/src/types.ts:261](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L261)
Defined in: [packages/events-amqp/src/types.ts:262](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L262)

***

### name

> `readonly` **name**: `string`

Defined in: [packages/events-amqp/src/types.ts:258](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L258)
Defined in: [packages/events-amqp/src/types.ts:259](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L259)
Loading
Loading