Reference

This section documents the public JavaScript API, run configuration, calculation context, result shape, and known limits. See Learn the framework for a guided introduction or the How-to guide for recipes.

• API overview
• Engine concepts
• Run configuration and inputs
• Time, phases, and schedules
• Calculation context
• Result format
• Valuation and uncertainty
• Packs
• Pack design notes
• Errors, ordering, and limits

Run lifecycle

1. Create references with API factories and collect them in defineModel().
2. compileModel() checks declarations, references, schedules, the entity tree, agreement windows, and dependency ordering.
3. run() normalizes its options and validates overridden inputs.
4. Each period is calculated in order: fields and states, agreement boundaries, events, cashflows, options, and flow distributors.
5. The result is created with series, metrics, and convenience accessors.

run() compiles a model automatically unless given a compiled plan. Call compileModel() separately when you want to validate before several runs.