realestate-jp/script/lib/rent/transitions.d.ts

不動産関連のユーティリティ関数を提供するライブラリ

import type { RentTransition } from "./types.js";
/**
 * 年ごとの家賃支払い推移を取得する
 *
 * @param rent 月額家賃
 * @param years 契約年数（デフォルト: 1年）
 * @param fee 月額維持費（デフォルト: 0）
 * @param renewCycle 契約更新の頻度（年単位、デフォルト: 0）
 * @param renewFee 更新料（月数、デフォルト: 0）
 * @param raiseRate 更新時の家賃値上げ率（% 単位、デフォルト: 0）
 * @returns 年ごとの支払い推移リスト
 *
 * @example 使用例
 * ```ts
 * import { getRentTransitions } from "@japanese/realestate";
 *
 * const transitions = getRentTransitions(85000, 10, 5000, 2, 1, 5);
 * console.table(transitions);
 * ```
 */
export declare function getRentTransitions(rent: number, years?: number, fee?: number, renewCycle?: number, renewFee?: number, raiseRate?: number): RentTransition[];
//# sourceMappingURL=transitions.d.ts.map