Function listenDoneLiveOnce

  • listenDoneLiveOnce(
        filterFn: (event: DoneContract) => boolean,
        fn: (event: DoneContract) => void,
    ): () => void

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

    Emits when Live.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

    Example

    import { listenDoneLiveOnce, Live } from "backtest-kit";

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

    Live.background("BTCUSDT", {
      strategyName: "my-strategy",
      exchangeName: "binance"
    });

Settings

Member Visibility