Function listenDoneBacktestOnce

  • Subscribes to filtered backtest background execution completion events with one-time execution.

    Emits when Backtest.background() completes execution. Executes callback once and automatically unsubscribes.

    Parameters

    • filterFn: (event: DoneContract) => boolean

      Predicate to filter which events trigger the callback

    • fn: (event: DoneContract) => void

      Callback function to handle the filtered event (called only once)

    Returns () => void

    Unsubscribe function to cancel the listener before it fires

    import { listenDoneBacktestOnce, Backtest } from "backtest-kit";

    // Wait for first backtest completion
    listenDoneBacktestOnce(
    (event) => event.symbol === "BTCUSDT",
    (event) => console.log("BTCUSDT backtest completed:", event.strategyName)
    );

    Backtest.background("BTCUSDT", {
    strategyName: "my-strategy",
    exchangeName: "binance",
    frameName: "1d-backtest"
    });