CohortRateResult

Defined in: types/domain.ts:400

Result returned by getRateForCohort.

Surfaces both the composite annual rate (annualRatePct) and its components (baseRatePct, premiumTier) along with the quarter window they apply to, so callers can audit how the rate was derived without re-running the math themselves.

Percentage fields are decimal strings expressed as percent values, e.g. "2.750" means 2.75% per annum.

Properties

annualRatePct

readonly annualRatePct: string;

Defined in: types/domain.ts:410

---

asOfDate

readonly asOfDate: string;

Defined in: types/domain.ts:403

---

baseRatePct

readonly baseRatePct: string;

Defined in: types/domain.ts:408

---

premiumTier

readonly premiumTier: PremiumTier;

Defined in: types/domain.ts:409

---

quarterEndDate

readonly quarterEndDate: string;

Defined in: types/domain.ts:405

---

quarterIndex

readonly quarterIndex: number;

Defined in: types/domain.ts:406

---

quarterStartDate

readonly quarterStartDate: string;

Defined in: types/domain.ts:404

---

series

readonly series: SeriesCode;

Defined in: types/domain.ts:401

---

subscriptionDate

readonly subscriptionDate: string;

Defined in: types/domain.ts:402

---

yearsSinceSubscription

readonly yearsSinceSubscription: number;

Defined in: types/domain.ts:407