Interface IdlePingContract

Contract for idle ping events when no signal is active.

Emitted by idlePingSubject every tick/minute when there is no pending or scheduled signal being monitored. Used for tracking idle strategy lifecycle.

Consumers:

  • User callbacks via listenIdlePing() / listenIdlePingOnce()
interface IdlePingContract {
    backtest: boolean;
    currentPrice: number;
    exchangeName: string;
    frameName: string;
    strategyName: string;
    symbol: string;
    timestamp: number;
}

Properties

backtest currentPrice exchangeName frameName strategyName symbol timestamp

Properties

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 ping.

exchangeName

exchangeName: string

Exchange name where this strategy is running.

frameName

frameName: string

Frame name (if backtest)

strategyName

strategyName: string

Strategy name that is in idle state.

symbol

symbol: string

Trading pair symbol (e.g., "BTCUSDT").

timestamp

timestamp: number

Event timestamp in milliseconds since Unix epoch.

Timing semantics:

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

Settings

Member Visibility

On This Page

Properties