Interface DoneContract

Contract for background execution completion events.

Emitted when Live.background() or Backtest.background() completes execution. Contains metadata about the completed execution context.

Example

import { listenDone } from "backtest-kit";

listenDone((event) => {
  if (event.backtest) {
    console.log("Backtest completed:", event.symbol);
  } else {
    console.log("Live trading completed:", event.symbol);
  }
});
interface DoneContract {
    backtest: boolean;
    exchangeName: string;
    frameName: string;
    strategyName: string;
    symbol: string;
    when: Date;
}

Properties

backtest exchangeName frameName strategyName symbol when

Properties

backtest

backtest: boolean

backtest - True if backtest mode, false if live mode

exchangeName

exchangeName: string

exchangeName - Name of the exchange used in execution

frameName

frameName: string

frameName - Name of the frame (empty string for live mode)

strategyName

strategyName: string

strategyName - Name of the strategy that completed

symbol

symbol: string

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

when

when: Date

Completion time as a Date instance.

  • Backtest mode: virtual execution time — the last processed candle timestamp from TimeMetaService, falling back to the frame's planned start date if no candle was processed.
  • Live mode: time of the last processed tick from TimeMetaService.

Settings

Member Visibility

On This Page

Properties