Skip to content

Graphorin API reference v0.8.0


Graphorin API reference / @graphorin/channels / / ChannelRuntimeContext

Interface: ChannelRuntimeContext

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

Runtime context handed to ChannelAdapter.start. The adapter pushes normalized inbound messages through onInbound and observes signal for shutdown.

Stable

Properties

PropertyModifierTypeDescriptionDefined in
signalreadonlyAbortSignalAborted when the gateway stops; adapters should cease polling/subscriptions.packages/channels/src/spi.ts:135

Methods

onInbound()

ts
onInbound(message): Promise<InboundAcceptance>;

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

Enqueue a normalized inbound message. Resolves once the message is accepted into (or shed from) the gateway's bounded queue - NOT once it has been processed.

Parameters

ParameterType
messageInboundChannelMessage

Returns

Promise&lt;InboundAcceptance&gt;