patrimoniumjs/reporting/history.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 { Reporting } from ".";
import { SimpleDate } from "..";
/**
 * Represents the financial reporting history of a `Person`.
 */
export declare class History {
    private readonly _reporting;
    /**
     * Returns a new instance of `History`.
     * @param reporting The reporting history of a `Person` as an array where the index is
     * the nth month since start and the element is the corresponding set of reports at that time.
     */
    constructor(reporting: Reporting[]);
    /**
     * Returns the month-over-month financial reports for the specified date.
     * @param date A `SimpleDate` instance.
     */
    getReporting(date: SimpleDate): Reporting;
    /**
     * Returns the financial reporting history of the person as an array.
     * Each index of the array is the nth month since start.
     */
    toArray(): Reporting[];
}