Interface ScheduleEventContract

Contract for scheduled signal lifecycle events (creation and cancellation).

Emitted by scheduleEventSubject when a scheduled signal is created (added) or cancelled during tick()/backtest() processing. Lets consumers track the scheduled phase of a signal without subscribing to the full signal stream.

IMPORTANT: The scheduled -> active transition (activation) is intentionally NOT emitted here. Activation produces an "opened" signal on the regular signal emitters; this contract only covers a scheduled signal being put in place and being removed before it ever opened.

Consumers:

  • User callbacks via listenScheduleEvent() / listenScheduleEventOnce()

Example

import { listenScheduleEvent } from "backtest-kit";

listenScheduleEvent((event) => {
  if (event.action === "scheduled") {
    console.log(`Scheduled ${event.symbol} @ ${event.data.priceOpen}`);
  } else {
    console.log(`Cancelled ${event.symbol} (reason: ${event.reason})`);
  }
});
interface ScheduleEventContract {
    action: "scheduled" | "cancelled";
    backtest: boolean;
    currentPrice: number;
    data: IPublicSignalRow;
    exchangeName: string;
    frameName: string;
    reason?: StrategyCancelReason;
    strategyName: string;
    symbol: string;
    timestamp: number;
}

Properties

action backtest currentPrice data exchangeName frameName reason? strategyName symbol timestamp

Properties

action

action: "scheduled" | "cancelled"

Lifecycle action for the scheduled signal.

  • "scheduled": a new scheduled signal was created (waiting for priceOpen activation)
  • "cancelled": the scheduled signal was removed before activation (timeout / price reject / user)

backtest

backtest: boolean

Execution mode flag.

  • true: Event from backtest execution (historical candle data)
  • false: Event from live trading (real-time tick)

currentPrice

currentPrice: number

Current market price of the symbol at the time of the event.

data

data: IPublicSignalRow

Complete scheduled signal row data in public form. Contains all signal information: id, position, priceOpen, priceTakeProfit, priceStopLoss, etc.

exchangeName

exchangeName: string

Exchange name where this scheduled signal lives.

frameName

frameName: string

Frame name (timeframe / date range) for the run. Empty string in live mode. Same value as the signal's frameName (data.frameName).

Optionalreason

reason?: StrategyCancelReason

Cancellation reason. Present only when action === "cancelled":

  • "timeout": CC_SCHEDULE_AWAIT_MINUTES elapsed without reaching priceOpen
  • "price_reject": price hit stop-loss before activation
  • "user": cancelled via cancelScheduled()

Always undefined when action === "scheduled".

strategyName

strategyName: string

Strategy name that owns this scheduled signal.

symbol

symbol: string

Trading pair symbol (e.g., "BTCUSDT"). Identifies which market this event belongs to.

timestamp

timestamp: number

Event timestamp in milliseconds since Unix epoch.

Timing semantics:

  • Live mode: when.getTime() at the moment of the event
  • Backtest mode: candle.timestamp of the candle being processed

Settings

Member Visibility

On This Page

Properties