CohortRateResult
Defined in: types/domain.ts:243
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
Section titled “Properties”annualRatePct
Section titled “annualRatePct”readonly annualRatePct: string;Defined in: types/domain.ts:253
asOfDate
Section titled “asOfDate”readonly asOfDate: string;Defined in: types/domain.ts:246
baseRatePct
Section titled “baseRatePct”readonly baseRatePct: string;Defined in: types/domain.ts:251
premiumTier
Section titled “premiumTier”readonly premiumTier: PremiumTier;Defined in: types/domain.ts:252
quarterEndDate
Section titled “quarterEndDate”readonly quarterEndDate: string;Defined in: types/domain.ts:248
quarterIndex
Section titled “quarterIndex”readonly quarterIndex: number;Defined in: types/domain.ts:249
quarterStartDate
Section titled “quarterStartDate”readonly quarterStartDate: string;Defined in: types/domain.ts:247
series
Section titled “series”readonly series: SeriesCode;Defined in: types/domain.ts:244
subscriptionDate
Section titled “subscriptionDate”readonly subscriptionDate: string;Defined in: types/domain.ts:245
yearsSinceSubscription
Section titled “yearsSinceSubscription”readonly yearsSinceSubscription: number;Defined in: types/domain.ts:250