Function listenSignalBacktestOnce

  • listenSignalBacktestOnce(
        filterFn: (event: IStrategyTickResult) => boolean,
        fn: (event: IStrategyTickResult) => void,
    ): () => void

    Subscribes to filtered backtest signal events with one-time execution.

    Only receives events from Backtest.run() execution. Executes callback once and automatically unsubscribes.

    Parameters

    • filterFn: (event: IStrategyTickResult) => boolean

      Predicate to filter which events trigger the callback

    • fn: (event: IStrategyTickResult) => void

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

    Returns () => void

    Unsubscribe function to cancel the listener before it fires

    Example

    import { listenSignalBacktestOnce } from "./function/event";

    // Wait for first backtest stop loss hit
    listenSignalBacktestOnce(
      (event) => event.action === "closed" && event.closeReason === "stop_loss",
      (event) => console.log("Backtest stop loss:", event.pnl.pnlPercentage)
    );

Settings

Member Visibility