Graphorin API reference v0.7.0
Graphorin API reference / @graphorin/server / / ConsolidatorLike
Interface: ConsolidatorLike
Defined in: packages/server/src/consolidator/daemon.ts:21
Structurally-typed view of the @graphorin/memory Consolidator surface. Importing the full type would force a hard dependency on @graphorin/memory; the structural subset captured here is enough for the lifecycle integration + the /v1/health aggregator.
Stable
Methods
drainDlq()?
optional drainDlq(): Promise<number>;Defined in: packages/server/src/consolidator/daemon.ts:28
Returns
Promise<number>
pause()?
optional pause(): Promise<void>;Defined in: packages/server/src/consolidator/daemon.ts:26
Returns
Promise<void>
registerWithScheduler()?
optional registerWithScheduler(scheduler): Promise<unknown>;Defined in: packages/server/src/consolidator/daemon.ts:36
Register the consolidator's cron / idle triggers with the server's triggers scheduler so background consolidation actually fires (MCON-4). Called from beforeStart when both a consolidator and a triggers daemon are configured. Optional so a consolidator without a defaultScope (or a custom surface) simply opts out.
Parameters
| Parameter | Type |
|---|---|
scheduler | Scheduler |
Returns
Promise<unknown>
resume()?
optional resume(): Promise<void>;Defined in: packages/server/src/consolidator/daemon.ts:27
Returns
Promise<void>
setTier()?
optional setTier(tier): Promise<void>;Defined in: packages/server/src/consolidator/daemon.ts:25
Parameters
| Parameter | Type |
|---|---|
tier | string |
Returns
Promise<void>
start()
start(): Promise<void>;Defined in: packages/server/src/consolidator/daemon.ts:22
Returns
Promise<void>
status()
status(): Promise<ConsolidatorStatusLike>;Defined in: packages/server/src/consolidator/daemon.ts:24
Returns
Promise<ConsolidatorStatusLike>
stop()
stop(): Promise<void>;Defined in: packages/server/src/consolidator/daemon.ts:23
Returns
Promise<void>