Skip to content

CohortRateResult

This content is not available in your language yet.

Defined in: types/domain.ts:419

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.

readonly annualRatePct: string;

Defined in: types/domain.ts:429


readonly asOfDate: string;

Defined in: types/domain.ts:422


readonly baseRatePct: string;

Defined in: types/domain.ts:427


readonly premiumTier: PremiumTier;

Defined in: types/domain.ts:428


readonly quarterEndDate: string;

Defined in: types/domain.ts:424


readonly quarterIndex: number;

Defined in: types/domain.ts:425


readonly quarterStartDate: string;

Defined in: types/domain.ts:423


readonly series: SeriesCode;

Defined in: types/domain.ts:420


readonly subscriptionDate: string;

Defined in: types/domain.ts:421


readonly yearsSinceSubscription: number;

Defined in: types/domain.ts:426