Function cancel

  • cancel(symbol: string, cancelId?: string): 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

    • OptionalcancelId: string

      Optional cancellation ID for tracking user-initiated cancellations

    Returns Promise<void>

    Promise that resolves when scheduled signal is cancelled

    Example

    import { cancel } from "backtest-kit";

    // Cancel scheduled signal with custom ID
    await cancel("BTCUSDT", "my-strategy", "manual-cancel-001");

Settings

Member Visibility