backtest-loop

A simple loop to walk through your candles and emit them as events for backtesting.

Installation

Install this package by running the following command:

npm install backtest-loop

Usage

import { Backtester, ITimeseries, ITimeSeriesEvent } from 'backtest-loop';

const ONE_MINUTE = 60000; // Time step size in milliseconds
const bt = new Backtester({ stepSize: ONE_MINUTE });
bt.setStartTime(1677196860000); // Set the start time for the backtest
bt.setEndTime(1677197400000);   // Set the end time for the backtest

// Subscribe to timeseries events to process new data points
bt.timeseriesEvents.subscribe((dataEvents: ITimeSeriesEvent[]) => {
  console.log('Received new data:', dataEvents);
});

// Subscribe to status updates
bt.status.subscribe((status: string) => {
  console.log('Received status:', status);
});

// Set the time series data for the backtest
bt.setData({
  timeseries: [
    { tsKey: 'openTime', data: dataset1, type: 'candle_1m', isComplete: false },
    { tsKey: 'openTime', data: dataset2, type: 'candle_5m', isComplete: false },
  ]
}).start();

// Continuously run the backtest steps until all data has been processed
while (bt.hasMoreDataToProcess()) {
  const dataEvents: ITimeSeriesEvent[] = bt.runNextStep();
  console.log(dataEvents);
}