Graphorin API reference v0.1.0

---

Graphorin API reference / @graphorin/memory / / Consolidator

Interface: Consolidator

Defined in: packages/memory/src/consolidator/runtime.ts:54

Consolidator runtime surface returned by createConsolidator. Compatible with the placeholder shape so the facade can swap the implementation without breaking consumers.

Stable

Methods

config()

config(): ConsolidatorConfig;

Defined in: packages/memory/src/consolidator/runtime.ts:73

Active config — frozen snapshot.

Returns

ConsolidatorConfig

---

drainDlq()

drainDlq(scope): Promise<number>;

Defined in: packages/memory/src/consolidator/runtime.ts:77

Drain DLQ rows whose nextRetryAt <= now.

Parameters

Parameter	Type
scope	SessionScope

Returns

Promise&lt;number&gt;

---

fireNow()

fireNow(phase, scope?): Promise<
  | PhaseOutcome
| null>;

Defined in: packages/memory/src/consolidator/runtime.ts:63

Manual trigger for the requested phase. Skips phase gating + the idle/cron scheduler so admins can flush the queue on demand.

Parameters

Parameter	Type
phase	ConsolidatorPhase
scope?	SessionScope

Returns

Promise< | PhaseOutcome | null>

---

isFree()

isFree(): boolean;

Defined in: packages/memory/src/consolidator/runtime.ts:75

True when tier === 'free'.

Returns

boolean

---

onPhaseFinished()

onPhaseFinished(listener): () => void;

Defined in: packages/memory/src/consolidator/runtime.ts:71

Subscribe to phase-finished notifications. Returns an unsubscribe.

Parameters

Parameter	Type
listener	PhaseListener

Returns

() => void

---

pause()

pause(): Promise<void>;

Defined in: packages/memory/src/consolidator/runtime.ts:67

Pause the consolidator until the next budget reset.

Returns

Promise&lt;void&gt;

---

resume()

resume(): Promise<void>;

Defined in: packages/memory/src/consolidator/runtime.ts:69

Resume after pause().

Returns

Promise&lt;void&gt;

---

setTier()

setTier(tier): Promise<void>;

Defined in: packages/memory/src/consolidator/runtime.ts:65

Replace the active tier — recomputes ceilings + phase set.

Parameters

Parameter	Type
tier	ConsolidatorTier

Returns

Promise&lt;void&gt;

---

start()

start(): Promise<void>;

Defined in: packages/memory/src/consolidator/runtime.ts:55

Returns

Promise&lt;void&gt;

---

status()

status(): Promise<ConsolidatorStatus>;

Defined in: packages/memory/src/consolidator/runtime.ts:58

Returns

Promise&lt;ConsolidatorStatus&gt;

---

stop()

stop(): Promise<void>;

Defined in: packages/memory/src/consolidator/runtime.ts:56

Returns

Promise&lt;void&gt;

---

trigger()

trigger(reason, scope): Promise<
  | PhaseOutcome
| null>;

Defined in: packages/memory/src/consolidator/runtime.ts:57

Parameters

Parameter	Type
reason	ConsolidatorTriggerReason
scope	SessionScope

Returns

Promise< | PhaseOutcome | null>