RungsOptions

Defined in: packages/core/src/service/create-rungs.ts:34

Host callbacks the service passes in. They may be sync or async.

Extends

• ResolutionHooks

Properties

calendar?

readonly optional calendar?: Calendar

Defined in: packages/core/src/service/create-rungs.ts:40

---

clock

readonly clock: () => Date

Defined in: packages/core/src/service/create-rungs.ts:37

Required: the core never reads a clock.

Returns

Date

---

dispatchRetry?

readonly optional dispatchRetry?: object

Defined in: packages/core/src/service/create-rungs.ts:52

Backoff for failed deliveries. Default { baseDelay: "PT30S", maxDelay: "PT1H" }.

baseDelay?

readonly optional baseDelay?: string

maxDelay?

readonly optional maxDelay?: string

---

events?

readonly optional events?: "outbox" | "discard"

Defined in: packages/core/src/service/create-rungs.ts:48

"discard" writes no outbox entries, for hosts that never consume events. Default "outbox".

---

ids

readonly ids: () => string

Defined in: packages/core/src/service/create-rungs.ts:39

Required: generates request ids.

Returns

string

---

isActiveUser?

readonly optional isActiveUser?: (userId, ctx) => boolean | Promise<boolean>

Defined in: packages/core/src/resolution/collect.ts:32

Omitted: every user is active.

Parameters

userId

string

ctx

ResolveContext

Returns

boolean | Promise<boolean>

Inherited from

ResolutionHooks.isActiveUser

---

onEvent?

readonly optional onEvent?: (event) => void | Promise<void>

Defined in: packages/core/src/service/create-rungs.ts:46

Called after each commit, in seq order, at least once. A throw never fails the command. Without it, events stay in the outbox for a process that has it, e.g. a worker running dispatchPending (EC-58).

Parameters

event

DomainEvent

Returns

void | Promise<void>

---

onEventError?

readonly optional onEventError?: (error, event, attempts) => void

Defined in: packages/core/src/service/create-rungs.ts:50

Called for each failed delivery; the event stays in the outbox and is retried later.

Parameters

error

unknown

event

DomainEvent

attempts

number

Returns

void

---

resolvers?

readonly optional resolvers?: Readonly<Record<string, (args) => UserIds>>

Defined in: packages/core/src/resolution/collect.ts:30

Inherited from

ResolutionHooks.resolvers

---

roles?

readonly optional roles?: (role, ctx) => UserIds

Defined in: packages/core/src/resolution/collect.ts:29

Parameters

role

string

ctx

ResolveContext

Returns

UserIds

Inherited from

ResolutionHooks.roles

---

store

readonly store: RungsStore

Defined in: packages/core/src/service/create-rungs.ts:35