Interface ProgressOptimizerContract

Contract for optimizer progress events.

Emitted during optimizer execution to track progress. Contains information about total sources, processed sources, and completion percentage.

Example

import { listenOptimizerProgress } from "backtest-kit";

listenOptimizerProgress((event) => {
  console.log(`Progress: ${(event.progress * 100).toFixed(2)}%`);
  console.log(`Processed: ${event.processedSources} / ${event.totalSources}`);
});
interface ProgressOptimizerContract {
    optimizerName: string;
    processedSources: number;
    progress: number;
    symbol: string;
    totalSources: number;
}

Properties

optimizerName processedSources progress symbol totalSources

Properties

optimizerName

optimizerName: string

optimizerName - Name of the optimizer being executed

processedSources

processedSources: number

processedSources - Number of sources processed so far

progress

progress: number

progress - Completion percentage from 0.0 to 1.0

symbol

symbol: string

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

totalSources

totalSources: number

totalSources - Total number of sources to process

Settings

Member Visibility

On This Page

Properties