Skip to content

Graphorin API reference v0.8.0


Graphorin API reference / @graphorin/channels / testkit / LoopbackAdapter

Interface: LoopbackAdapter

Defined in: packages/channels/src/testkit/loopback-adapter.ts:38

The in-memory loopback adapter: a full ChannelAdapter whose transport is the test itself. Tests inject() inbound messages and read deliveries for what the gateway sent back.

Stable

Extends

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
capabilitiesreadonlyChannelCapabilities-ChannelAdapter.capabilitiespackages/channels/src/spi.ts:216
deliveriesreadonlyreadonly DeliveryPayload[]Every payload delivered so far, in order (post-sanitization).-packages/channels/src/testkit/loopback-adapter.ts:42
idreadonlystringStable channel id; becomes ChannelIdentity.channelId on inbound.ChannelAdapter.idpackages/channels/src/spi.ts:215
startedreadonlyboolean--packages/channels/src/testkit/loopback-adapter.ts:43

Methods

deliver()

ts
deliver(payload): Promise<DeliveryReceipt>;

Defined in: packages/channels/src/spi.ts:225

Deliver one outbound payload. Throws ChannelDeliveryError after in-call retries are exhausted (D-14: no durable outbox).

Parameters

ParameterType
payloadDeliveryPayload

Returns

Promise&lt;DeliveryReceipt&gt;

Inherited from

ChannelAdapter.deliver


failNextDeliver()

ts
failNextDeliver(): void;

Defined in: packages/channels/src/testkit/loopback-adapter.ts:45

Make the next deliver call throw a retryable ChannelDeliveryError.

Returns

void


inject()

ts
inject(input): Promise<InboundAcceptance>;

Defined in: packages/channels/src/testkit/loopback-adapter.ts:40

Push one inbound message through the gateway (must be started).

Parameters

ParameterType
inputLoopbackInboundInput

Returns

Promise&lt;InboundAcceptance&gt;


start()

ts
start(ctx): Promise<void>;

Defined in: packages/channels/src/spi.ts:218

Subscribe / start polling. Resolves once the adapter is receiving.

Parameters

ParameterType
ctxChannelRuntimeContext

Returns

Promise&lt;void&gt;

Inherited from

ChannelAdapter.start


stop()

ts
stop(): Promise<void>;

Defined in: packages/channels/src/spi.ts:220

Stop receiving; idempotent.

Returns

Promise&lt;void&gt;

Inherited from

ChannelAdapter.stop