Function commitCreateTakeProfit

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

    Reports that the pending position's take-profit order was actually filled on the exchange (e.g. by candle high/low), forcing a close that bypasses the VWAP-based TP check.

    The exchange and the strategy are parallel states: the framework evaluates TP/SL against VWAP, but the real order may fill on high/low. The close is deferred and emitted with closeReason "take_profit" on the next tick. No-op if no pending signal exists.

    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 the take-profit fill is queued

    Example

    import { commitCreateTakeProfit } from "backtest-kit";

    // Report TP fill confirmed on the exchange
    await commitCreateTakeProfit("BTCUSDT", { id: "tp-fill-001" });

Settings

Member Visibility