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

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

import type { RentSummary } from "./types.js";
/**
 * 家賃支払いのサマリーを計算する
 *
 * @param rent 月額家賃
 * @param years 契約年数（デフォルト: 1年）
 * @param fee 月額維持費（デフォルト: 0）
 * @param renewCycle 契約更新の頻度（年単位、デフォルト: 0＝更新なし）
 * @param renewFee 更新料（月数単位、デフォルト: 0）
 * @param raiseRate 更新時の家賃値上げ率（% 単位、デフォルト: 0）
 * @returns 支払いサマリー情報
 *
 * @example 使用例
 * ```ts
 * import { getRentSummary } from "@japanese/realestate";
 *
 * const summary = getRentSummary(85000, 10, 5000, 2, 1, 5);
 * console.log(summary);
 * ```
 */
export declare function getRentSummary(rent: number, years?: number, fee?: number, renewCycle?: number, renewFee?: number, raiseRate?: number): RentSummary;
//# sourceMappingURL=summary.d.ts.map