simulate
function simulate(input, options?): SimulateResult;Defined in: core/calculator.ts:119
Simulates the value of an IGCP Aforro Série F certificate for a given
cohort up to asOfDate (defaults to today, UTC).
Returns the capitalized totals plus, when the as-of date falls between two
quarterly capitalizations, the gross interest accrued (pro-rated by
calendar days) since the last capitalization. The returned units echoes
the input principal — every other amount is a banker’s-rounded decimal
string so callers can JSON-serialize without precision loss.
When includeSchedule is true, every completed quarter is materialized
in SimulateResult.schedule with the rate components, gross / IRS /
net interest, and the running balance after capitalization.
Parameters
Seção intitulada “Parameters”| Parameter | Type |
|---|---|
input | SimulateInput |
options | SimulateOptions |
Returns
Seção intitulada “Returns”when input fails Zod validation, when the Euribor 3M series (bundled dataset or BaseRateOptions.observations override) cannot resolve the IGCP fixing window for any quarter the loop must process (including the in-flight quarter when computing accrued), or when the resolved series has no premium tier for the contract year.