patrimoniumjs/property-improvement.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.

/**
 * Represents the act of improving a property (ie, increasing its value by some work).
 */
export interface PropertyImprovement {
    /**
     * The cost of the improvement.
     */
    cost: number;
    /**
     * The added value of the improvement (ie, how much the property worth is increasing after the improvement).
     */
    addedValue: number;
    /**
     * The index of a `Person` property to improve. If not provided, the first property is improved.
     */
    propertyIdx?: number;
}