patrimoniumjs/property.d.ts

Patrimonium.js is a JavaScript library providing a set of tools to modelize the real estate operations of an individual and their impact on the financial situation of the same individual.

import { RecurrentPropertyExpenses } from "./property-purchase";
/**
 * Represents a property of a `Person`.
 */
export interface Property {
    /**
     * The amount paid when the `Property` was purchased.
     */
    purchasePrice: number;
    /**
     * The current price of the `Property`.
     */
    currentWorth: number;
    /**
     * The recurrent expenses related to this `Property`.
     */
    recurrentExpenses: RecurrentPropertyExpenses;
    /**
     * Potential monthly rent (without utilities) if the `Property` is rented out.
     */
    rent: number;
    state: 'usedAsPrincipalResidence' | 'rented' | 'empty';
    /**
     * The annual growth rate of the `Property` worth, expressed as a decimal fraction (value between 0 and 1).
     */
    growthRate: number;
}