Rulvar API reference

---

Rulvar API reference / @rulvar/rulvar / EffectLaneWriter

Class: EffectLaneWriter

Defined in: packages/core/dist/index.d.ts

Constructors

Constructor

new EffectLaneWriter(options): EffectLaneWriter;

Defined in: packages/core/dist/index.d.ts

Parameters

Parameter	Type
options	EffectLaneWriterOptions

Returns

EffectLaneWriter

Methods

appendDisposition()

appendDisposition(intentSeq, spec): Promise<EffectAppendResult>;

Defined in: packages/core/dist/index.d.ts

Records a human disposition of a quarantine or an incident.

Parameters

Parameter	Type
intentSeq	number
spec	{ causalRef?: number; disposition: string; opId: string; principal: string; reason: string; }
spec.causalRef?	number
spec.disposition	string
spec.opId	string
spec.principal	string
spec.reason	string

Returns

Promise<EffectAppendResult>

---

appendIncident()

appendIncident(intentSeq, spec): Promise<EffectAppendResult>;

Defined in: packages/core/dist/index.d.ts

Records a linked incident on a machine.

Parameters

Parameter	Type
intentSeq	number
spec	{ causalRef?: number; detail?: string; incident: string; opId: string; }
spec.causalRef?	number
spec.detail?	string
spec.incident	string
spec.opId	string

Returns

Promise<EffectAppendResult>

---

appendOutcome()

appendOutcome(
   intentSeq, 
   attemptSeq, 
spec): Promise<EffectAppendResult>;

Defined in: packages/core/dist/index.d.ts

Classifies one open attempt's result.

Parameters

Parameter	Type
intentSeq	number
attemptSeq	number
spec	{ detail?: string; opId: string; outcome: "accepted" | "unknown" | "failed"; }
spec.detail?	string
spec.opId	string
spec.outcome	"accepted" | "unknown" | "failed"

Returns

Promise<EffectAppendResult>

---

appendProbe()

appendProbe(intentSeq, spec): Promise<EffectAppendResult>;

Defined in: packages/core/dist/index.d.ts

Journals one provider probe (the durable lookup budget row).

Parameters

Parameter	Type
intentSeq	number
spec	{ acceptanceClosed?: boolean; found: boolean; opId?: string; probe: "lookup" | "close-acceptance"; }
spec.acceptanceClosed?	boolean
spec.found	boolean
spec.opId?	string
spec.probe	"lookup" | "close-acceptance"

Returns

Promise<EffectAppendResult>

---

appendReceipt()

appendReceipt(intentSeq, spec): Promise<EffectAppendResult>;

Defined in: packages/core/dist/index.d.ts

Records a receipt observation with the caller's verification verdict.

Parameters

Parameter	Type
intentSeq	number
spec	{ amount?: number; currency?: string; detail?: string; documentHash?: string; opId: string; providerRef?: string; timestamp?: string; transferId?: string; verification: "verified" | "unverified"; }
spec.amount?	number
spec.currency?	string
spec.detail?	string
spec.documentHash?	string
spec.opId	string
spec.providerRef?	string
spec.timestamp?	string
spec.transferId?	string
spec.verification	"verified" | "unverified"

Returns

Promise<EffectAppendResult>

---

appendReconciliationComplete()

appendReconciliationComplete(spec): Promise<EffectAppendResult>;

Defined in: packages/core/dist/index.d.ts

Releases a restoration epoch after its sweep (RFC 4.5, item 3).

Parameters

Parameter	Type
spec	{ epochRef: number; opId: string; swept: number; }
spec.epochRef	number
spec.opId	string
spec.swept	number

Returns

Promise<EffectAppendResult>

---

appendStandaloneQuarantine()

appendStandaloneQuarantine(spec): Promise<EffectAppendResult>;

Defined in: packages/core/dist/index.d.ts

A durable standalone quarantine (the kill 25 sweep records).

Parameters

Parameter	Type
spec	{ logicalKey: string; opId: string; reason: string; }
spec.logicalKey	string
spec.opId	string
spec.reason	string

Returns

Promise<EffectAppendResult>

---

appendStandaloneRefusal()

appendStandaloneRefusal(spec): Promise<EffectAppendResult>;

Defined in: packages/core/dist/index.d.ts

A durable standalone refusal for a logical key (no machine).

Parameters

Parameter	Type
spec	{ logicalKey: string; opId: string; reason: string; }
spec.logicalKey	string
spec.opId	string
spec.reason	string

Returns

Promise<EffectAppendResult>

---

appendTerminal()

appendTerminal(intentSeq, spec): Promise<EffectAppendResult>;

Defined in: packages/core/dist/index.d.ts

Appends a terminal transition; the fold's legality rules decide.

Parameters

Parameter	Type
intentSeq	number
spec	{ causalRef?: number; opId: string; reason?: string; terminal: EffectTerminalState; }
spec.causalRef?	number
spec.opId	string
spec.reason?	string
spec.terminal	EffectTerminalState

Returns

Promise<EffectAppendResult>

---

close()

close(): Promise<void>;

Defined in: packages/core/dist/index.d.ts

Returns

Promise<void>

---

consumeApprovalAndRecordIntent()

consumeApprovalAndRecordIntent(spec): Promise<EffectConsumeResult>;

Defined in: packages/core/dist/index.d.ts

Consumes a standing approval and records the intent as ONE append (RFC section 4.3). Intake refusals (an effect approval without a deadline; a grant expiry the local clock has crossed, which the writer first materializes as an appended approval_expired decision, the deterministic truth) throw typed WITHOUT appending an intent. A contention give-up appends a durable standalone refused record, then throws.

Parameters

Parameter	Type
spec	EffectIntentSpec

Returns

Promise<EffectConsumeResult>

---

ensureEpoch()

ensureEpoch(generation): Promise<EffectAppendResult>;

Defined in: packages/core/dist/index.d.ts

Appends the run incarnation's epoch fact (RFC section 4.5, item 2) when the latest epoch does not already record this generation and the store's current restoration generation. Idempotent by its derived operation id.

Parameters

Parameter	Type
generation	string

Returns

Promise<EffectAppendResult>

---

entriesSnapshot()

entriesSnapshot(): Promise<readonly JournalEntry[]>;

Defined in: packages/core/dist/index.d.ts

The writer's current loaded entries (read-only snapshot).

Returns

Promise<readonly JournalEntry[]>

---

open()

open(): Promise<void>;

Defined in: packages/core/dist/index.d.ts

Returns

Promise<void>

---

openAttempt()

openAttempt(intentSeq, spec): Promise<
  | {
  cancelled: true;
  terminalSeq: number;
}
  | {
  attemptSeq: number;
  cancelled: false;
  replayed: boolean;
}>;

Defined in: packages/core/dist/index.d.ts

Opens one dispatch attempt (RFC section 3.1, item 3), with the pre-attempt re-fold of section 4.3, item 5: a revocation or expiry with ZERO attempts cancels cleanly (the writer appends cancelled-before-dispatch and reports it); with an open history it refuses typed, because recovery from that position is reconcile-only on every capability row.

Parameters

Parameter	Type
intentSeq	number
spec	{ idempotencyKey?: string; notAfter: string; opId: string; transport?: string; }
spec.idempotencyKey?	string
spec.notAfter	string
spec.opId	string
spec.transport?	string

Returns

Promise< | { cancelled: true; terminalSeq: number; } | { attemptSeq: number; cancelled: false; replayed: boolean; }>

---

refresh()

refresh(): Promise<EffectLaneFold>;

Defined in: packages/core/dist/index.d.ts

Reloads the journal and returns the fresh fold.

Returns

Promise&lt;EffectLaneFold&gt;

---

view()

view(): EffectLaneFold;

Defined in: packages/core/dist/index.d.ts

The current fold over the writer's loaded view.

Returns

EffectLaneFold