Appearance

API reference@connectum/events-amqpDocs 1.3.x

Connectum API Reference / @connectum/events-amqp / testing / FakeAmqpControl

Interface: FakeAmqpControl ​

Defined in: packages/events-amqp/src/testing.ts:144

Deterministic control surface of the fake.

Properties ​

published ​

readonly published: readonly FakePublishedRecord[]

Defined in: packages/events-amqp/src/testing.ts:217

Successfully acked publishes, in order.

Methods ​

block() ​

block(reason?): void

Defined in: packages/events-amqp/src/testing.ts:207

Broker flow control: blocked { reason } / unblocked (union-only events).

Parameters ​

reason? ​

string

Returns ​

void

completeRecovery() ​

completeRecovery(): void

Defined in: packages/events-amqp/src/testing.ts:167

Advance a pending recovery: consumes a queued failSetup (reported per its gating, stays recovering) or, with nothing queued, completes with connected { reconnected: true } and settles parked subscribes.

Returns ​

void

deliver() ​

deliver(eventType, payload, options?): Promise<FakeDeliveryResult>

Defined in: packages/events-amqp/src/testing.ts:229

Deliver an event to the subscriptions the configured exchange type routes it to (see FakeAmqpAdapterOptions.exchangeType: topic and direct use the shared EventBus wildcard matcher, fanout and headers reach every subscription), one consumer per distinct group — competing-consumer parity. Requires the connected state, like a real broker. Internal envelope keys (x-event-id, x-published-at, x-connectum-publish-id) are honored and stripped from handler-visible metadata, mirroring the real consumer. Resolves with the settlement summary once every handler settles; handler rejections are swallowed (counted in failed).

Parameters ​

eventType ​

string

payload ​

Uint8Array

options? ​
attempt? ​

number

metadata? ​

Record<string, string>

Returns ​

Promise<FakeDeliveryResult>

dropConnection() ​

dropConnection(error?): void

Defined in: packages/events-amqp/src/testing.ts:161

Sever the connection: dispatches disconnected { error } then reconnecting { attempt: 1, delay: 0 } and parks in the recovering state — publishes fail fast with AmqpConnectionError, exactly like the real adapter's recovery window; new subscribe() calls PARK.

Parameters ​

error? ​

Error

Returns ​

void

exhaustRecovery() ​

exhaustRecovery(error?): void

Defined in: packages/events-amqp/src/testing.ts:176

Terminal outcome: reconnect-failed { error }. Like the real adapter, the dead cycle is forgotten BEFORE the event is dispatched: publishes and new subscribes fail fast with the real adapter's typed "not connected" error, all subscriptions are dropped (the cycle died — so did its consumers), and a later connect() starts clean without them. Parked subscribes reject with a typed AmqpConnectionError.

Parameters ​

error? ​

Error

Returns ​

void

failSetup() ​

failSetup(error?, object?): void

Defined in: packages/events-amqp/src/testing.ts:154

Queue a setup failure. An AmqpTopologyError (the default) follows the real gating: setup-failed { initial: true, attempt: 0 } at connect() (typed rejection under failFastOnInitialSetupError), or setup-failed { initial: false, attempt } at the next completeRecovery. A NON-topology error follows the real gating too: no setup-failed event — at connect() it is consumed silently, at completeRecovery it only schedules the next reconnecting.

Parameters ​

error? ​

Error

object? ​

AmqpTopologyObject

Returns ​

void

loseConsumer() ​

loseConsumer(options?): void

Defined in: packages/events-amqp/src/testing.ts:195

The broker ends consumers while the connection stays up (the queue was deleted, the consumer was cancelled, the consumer channel was closed by a channel exception). Every matching live subscription stops receiving deliveries and gets one consumer-lost { queue, cause, error?, willRestore } (willRestore mirrors the recovery option). Union-only event, no flat-callback equivalent.

The fake has no exchange, so a subscription's queue is its group, or fake.sub-N (N = 1-based order of registration) when it has none. Without queue, every live subscription is lost; with it, every live subscription on that queue is, even for channel-closed (see the divergence list above).

Throws when the adapter is not connected (a connection loss is driven by dropConnection) or when nothing matches, so a test cannot silently exercise nothing.

Parameters ​

options? ​
cause? ​

AmqpConsumerLossCause

error? ​

Error

queue? ​

string

Returns ​

void

nextPublish() ​

nextPublish(...outcomes): void

Defined in: packages/events-amqp/src/testing.ts:215

Queue FIFO outcomes for upcoming publish() calls. An empty queue means "ack". Use the real error classes (AmqpPublishNackError, AmqpConnectionError, AmqpPublishTimeoutError — the state-UNKNOWN outcome only this fake reproduces deterministically, …).

Parameters ​

outcomes ​

...FakePublishOutcome[]

Returns ​

void

restoreConsumers() ​

restoreConsumers(): void

Defined in: packages/events-amqp/src/testing.ts:205

Bring every lost subscription back: it receives deliveries again and consumer-restored { queue, attempt: 1 } is delivered once per subscription. Throws when the adapter is not connected, when recovery: false (the real adapter would not restore), or when nothing is lost. A completeRecovery also brings lost subscriptions back, silently: connection recovery re-creates every consumer, as in the real adapter.

Returns ​

void

unblock() ​

unblock(): void

Defined in: packages/events-amqp/src/testing.ts:208

Returns ​

void