@plures/praxis

---

@plures/praxis / index / enableProjectChronicle

Function: enableProjectChronicle()

enableProjectChronicle<TContext>(registry, engine, options?): ChronicleHandle

Defined in: src/chronos/hooks.ts:57

Enable project-level chronicle recording.

Wraps registry's registerRule, registerModule and engine's step, checkConstraints methods to automatically record events.

Type Parameters

TContext

TContext = unknown

Parameters

registry

PraxisRegistry<TContext>

The Praxis registry to instrument for auto-recording

engine

LogicEngine<TContext>

The logic engine to instrument for step and constraint recording

options?

EnableChronicleOptions = {}

Chronicle options: existing chronicle instance and feature toggles

Returns

ChronicleHandle

A handle with the chronicle and a disconnect() to undo all hooks.

Example

const { chronicle, disconnect } = enableProjectChronicle(registry, engine);
registry.registerRule(myRule); // auto-recorded
engine.step(events);          // step results auto-recorded
console.log(chronicle.size);  // number of events recorded
disconnect();                 // stop recording