Skip to main content

Interface: ReceiverOptions<S, P>

Defined in: packages/messaging/src/receiver.ts:163

Options for a Receiver. Everything with a side effect is injected.

Type Parameters​

S​

S

P​

P

Properties​

clock?​

readonly optional clock?: Clock

Defined in: packages/messaging/src/receiver.ts:182

Defaults to the system clock.

handlers?​

readonly optional handlers?: HandlerMap<S, P>

Defined in: packages/messaging/src/receiver.ts:169

Handlers by registry key. More can be added with Receiver.register.

hosting?​

readonly optional hosting?: HostingInput

Defined in: packages/messaging/src/receiver.ts:186

The permission table and hosting map; defaults to the real estate.

idempotency?​

readonly optional idempotency?: IdempotencyHook

Defined in: packages/messaging/src/receiver.ts:180

Wraps every mutation. See IdempotencyHook.

logger?​

readonly optional logger?: MessagingLogger

Defined in: packages/messaging/src/receiver.ts:184

Defaults to a logger that discards.

module​

readonly module: "identity" | "audit" | "governance" | "trust" | "issuance" | "verification" | "vault" | "signing" | "e-services" | "provisioning"

Defined in: packages/messaging/src/receiver.ts:165

The module this receiver serves. Its host is decided by the hosting table.

onDeny?​

readonly optional onDeny?: AccessDenyHook

Defined in: packages/messaging/src/receiver.ts:178

Called on every refusal. See AccessDenyHook.

scopeFromActor​

readonly scopeFromActor: ScopeFromActor<S, P>

Defined in: packages/messaging/src/receiver.ts:167

Mints the scope; scopeFromActor from @oktoid/authz.

verifier?​

readonly optional verifier?: ActorVerifier

Defined in: packages/messaging/src/receiver.ts:176

Checks the actor tokens messages carry: an ActorTokenVerifier built by the module's wiring with the verify keys from the secret store. Defaults to one with no keys, which refuses every token, so a receiver whose wiring forgot the keys fails closed rather than trusting the envelope.