rulvar API reference / @rulvar/rulvar / CreateEngineOptions
Interface: CreateEngineOptions
Defined in: packages/core/dist/index.d.ts
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
adapters | ProviderAdapter[] | - | packages/core/dist/index.d.ts |
budgetDefaults? | BudgetDefaults | - | packages/core/dist/index.d.ts |
concurrency? | { perProvider?: Record<string, number>; perRun?: number; } | - | packages/core/dist/index.d.ts |
concurrency.perProvider? | Record<string, number> | - | packages/core/dist/index.d.ts |
concurrency.perRun? | number | - | packages/core/dist/index.d.ts |
defaults? | EngineDefaults | - | packages/core/dist/index.d.ts |
extraDerivers? | readonly unknown[] | KeyDeriver registry extension (see https://docs.rulvar.com/guide/journal-compatibility). Plumbed now, consumed by the matching kernel from M2. | packages/core/dist/index.d.ts |
onEscalation? | (result) => | EscalationDecision | Promise<EscalationDecision> | The InProcessRunner escalation hook: receives escalated results when the call form cannot carry them; the returned decision is journaled as the authoritative escalation-decision entry. | packages/core/dist/index.d.ts |
pricing? | PriceTable | Versioned price table; wins over caps.pricing (M4-T06). | packages/core/dist/index.d.ts |
redaction? | { maskEvents?: boolean; } | The default key-masking policy at the telemetry boundary. Default ON: key-shaped strings in every emitted WorkflowEvent are masked; never touches the journal. | packages/core/dist/index.d.ts |
redaction.maskEvents? | boolean | - | packages/core/dist/index.d.ts |
runners? | { sandbox?: ScriptRunner; } | Runner registrations beyond the built-in InProcessRunner (M6-T02). sandbox executes CompiledWorkflow values (WorkerSandboxRunner ships in @rulvar/planner); running or resuming a compiled workflow without one is a typed ConfigError. | packages/core/dist/index.d.ts |
runners.sandbox? | ScriptRunner | - | packages/core/dist/index.d.ts |
serialization? | SerializationHook | Redact/encrypt at the append/put boundaries, symmetric on load/get (M8-T04, OQ-22 executed). Applied by wrapping the configured stores; Engine.stores exposes the wrapped instances, so every reader passes one policy point. | packages/core/dist/index.d.ts |
stores? | { journal?: JournalStore; modelKnowledge?: ModelKnowledgeStore; transcripts?: TranscriptStore; } | - | packages/core/dist/index.d.ts |
stores.journal? | JournalStore | Default InMemoryStore (resume disabled, loud warning). | packages/core/dist/index.d.ts |
stores.modelKnowledge? | ModelKnowledgeStore | The ModelKnowledge claim store (M10-T03). Optional and OFF by default: an engine without it writes no kb entries at all. The runtime only ever receives the current()-only handle. | packages/core/dist/index.d.ts |
stores.transcripts? | TranscriptStore | - | packages/core/dist/index.d.ts |