Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/effects / EffectReconciler

Class: EffectReconciler

Defined in: packages/effects/src/reconciler.ts:51

Constructors

Constructor

ts
new EffectReconciler(options): EffectReconciler;

Defined in: packages/effects/src/reconciler.ts:56

Parameters

ParameterType
optionsEffectReconcilerOptions

Returns

EffectReconciler

Methods

reconcileRestoration()

ts
reconcileRestoration(options?): Promise<RestorationReport>;

Defined in: packages/effects/src/reconciler.ts:234

The post-restore reconciliation (RFC section 4.5, item 3; kill 25). Requires the current epoch to be a restoration epoch awaiting release. With enumerate, every provider effect whose logical key has no consumed intent anywhere in the journal quarantines standalone by name (what could NOT be reconstructed), and open machines re-enter recovery through the ordinary sweep. Without authoritative enumeration the whole affected range quarantines as one named record and automatic recovery is forbidden. Either way the sweep runs, the completion decision appends, and attempt dispatch re-enables for the epoch.

Parameters

ParameterType
options?{ enumerate?: () => Promise&lt;{ logicalKey: string; receipt?: EffectReceiptObservation; }[]&gt;; }
options.enumerate?() => Promise&lt;{ logicalKey: string; receipt?: EffectReceiptObservation; }[]&gt;

Returns

Promise&lt;RestorationReport&gt;


sweep()

ts
sweep(options?): Promise<EffectSweepReport>;

Defined in: packages/effects/src/reconciler.ts:170

Parameters

ParameterType
options{ recover?: boolean; }
options.recover?boolean

Returns

Promise&lt;EffectSweepReport&gt;