financial-calcs
Version:
Reusable financial calculation library for FERS, Social Security, retirement savings, and mortgage amortization
29 lines • 1.2 kB
TypeScript
export interface SocialSecurityBenefitInput {
startYear: number;
birthYear: number;
claimingAge: number;
averageIncome: number;
averageCOLA: number;
yearsToProject: number;
yearOverrides?: SocialSecurityBenefitYearOverrides;
}
export type SocialSecurityBenefitYearOverrides = Record<number, SocialSecurityBenefitOverride>;
export interface SocialSecurityBenefitOverride {
colaApplied?: number;
}
export interface SocialSecurityBenefitProjectionRow {
year: number;
age: number;
colaApplied: number;
annualBenefit: number;
monthlyBenefit: number;
hasOverride?: boolean;
}
export interface SocialSecurityValidationError {
field: keyof SocialSecurityBenefitInput;
message: string;
}
export declare function validateSocialSecurityBenefitInput(input: SocialSecurityBenefitInput): SocialSecurityValidationError[];
export declare function calculateSocialSecurityBenefitProjection(input: SocialSecurityBenefitInput): SocialSecurityBenefitProjectionRow[];
export declare function calculateSocialSecurityBenefitProjectionWithOverrides(input: SocialSecurityBenefitInput): SocialSecurityBenefitProjectionRow[];
//# sourceMappingURL=benefit.d.ts.map