Skip to content

Graphorin API reference v0.7.0


Graphorin API reference / @graphorin/memory / / Consolidator

Interface: Consolidator

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

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

Stable

Methods

config()

ts
config(): ConsolidatorConfig;

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

Active config - frozen snapshot.

Returns

ConsolidatorConfig


drainDlq()

ts
drainDlq(scope): Promise<number>;

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

Drain DLQ rows whose nextRetryAt <= now.

Parameters

ParameterType
scopeSessionScope

Returns

Promise&lt;number&gt;


fireNow()

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

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

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

Parameters

ParameterType
phaseConsolidatorPhase
scope?SessionScope

Returns

Promise< | PhaseOutcome | null>


isFree()

ts
isFree(): boolean;

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

True when tier === 'free'.

Returns

boolean


onPhaseFinished()

ts
onPhaseFinished(listener): () => void;

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

Subscribe to phase-finished notifications. Returns an unsubscribe.

Parameters

ParameterType
listenerPhaseListener

Returns

() => void


pause()

ts
pause(): Promise<void>;

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

Pause the consolidator until the next budget reset.

Returns

Promise&lt;void&gt;


recordExternalSpend()

ts
recordExternalSpend(tokens, costUsd?): void;

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

Record memory-pipeline LLM spend that happened OUTSIDE a phase run (MCON-15 - e.g. workflow induction) so the daily ceilings cover it. Counted under the deep-phase bucket.

Parameters

ParameterType
tokensnumber
costUsd?number

Returns

void


registerWithScheduler()

ts
registerWithScheduler(scheduler): Promise<RegisterTriggersResult>;

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

Register this consolidator's cron / idle triggers with a @graphorin/triggers scheduler so they fire trigger(...) automatically (the daemon ↔ triggers bridge - MCON-4). Uses the configured defaultScope; throws if none was set. Turn / event triggers are skipped (consumer-emitted). The standalone server calls this in beforeStart.

Parameters

ParameterType
schedulerSchedulerLike

Returns

Promise&lt;RegisterTriggersResult&gt;


resume()

ts
resume(): Promise<void>;

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

Resume after pause().

Returns

Promise&lt;void&gt;


setTier()

ts
setTier(tier): Promise<void>;

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

Replace the active tier - recomputes ceilings + phase set.

Parameters

ParameterType
tierConsolidatorTier

Returns

Promise&lt;void&gt;


start()

ts
start(): Promise<void>;

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

Returns

Promise&lt;void&gt;


status()

ts
status(): Promise<ConsolidatorStatus>;

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

Returns

Promise&lt;ConsolidatorStatus&gt;


stop()

ts
stop(): Promise<void>;

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

Returns

Promise&lt;void&gt;


trigger()

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

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

Parameters

ParameterType
reasonConsolidatorTriggerReason
scopeSessionScope

Returns

Promise< | PhaseOutcome | null>