@showr/core/dist/backtestReport.d.ts

Core library for Showr

/**
 * Creates a back-test report.
 */
export declare class BacktestReport {
    _currentCapital: number;
    profit: number;
    loss: number;
    numberOfTrades: number;
    initialCapital: number;
    finalCapital: number;
    returns: number;
    /**
     * Defines the initial capital for the back-test.
     * @param initialCapital - Initial capital for the back-test.
     */
    constructor(initialCapital: number);
    private updateCapital;
    private updateTotals;
    /**
     * Updates the capital according to the traded value after executing the entry position.
     * @param tradedValue - Traded value at the time.
     */
    markEntry(tradedValue: number): void;
    /**
     * Updates the capital according to the traded value after executing the exit position.
     * @param tradedValue - Traded value at the time.
     */
    markExit(tradedValue: number): void;
}