Function commitCancelScheduled

  • commitCancelScheduled(
        symbol: string,
        payload?: Partial<CommitPayload>,
    ): Promise<void>

    Cancels the scheduled signal without stopping the strategy.

    Clears the scheduled signal (waiting for priceOpen activation). Does NOT affect active pending signals or strategy operation. Does NOT set stop flag - strategy can continue generating new signals.

    Automatically detects backtest/live mode from execution context.

    Parameters

    • symbol: string

      Trading pair symbol

    • Optionalpayload: Partial<CommitPayload>

      Optional commit payload with id and note

    Returns Promise<void>

    Promise that resolves when scheduled signal is cancelled

    Example

    import { commitCancelScheduled } from "backtest-kit";

    // Cancel scheduled signal with custom ID
    await commitCancelScheduled("BTCUSDT", { id: "manual-cancel-001" });

Settings

Member Visibility