Interface ProgressBacktestContract

Contract for backtest progress events.

Emitted during Backtest.background() execution to track progress. Contains information about total frames, processed frames, and completion percentage.

Example

import { listenBacktestProgress } from "backtest-kit";

listenBacktestProgress((event) => {
  console.log(`Progress: ${(event.progress * 100).toFixed(2)}%`);
  console.log(`Processed: ${event.processedFrames} / ${event.totalFrames}`);
});
interface ProgressBacktestContract {
    exchangeName: string;
    processedFrames: number;
    progress: number;
    strategyName: string;
    symbol: string;
    totalFrames: number;
}

Properties

exchangeName processedFrames progress strategyName symbol totalFrames

Properties

exchangeName

exchangeName: string

exchangeName - Name of the exchange used in execution

processedFrames

processedFrames: number

processedFrames - Number of frames processed so far

progress

progress: number

progress - Completion percentage from 0.0 to 1.0

strategyName

strategyName: string

strategyName - Name of the strategy being executed

symbol

symbol: string

symbol - Trading symbol (e.g., "BTCUSDT")

totalFrames

totalFrames: number

totalFrames - Total number of frames to process

Settings

Member Visibility

On This Page

Properties