Interface PingContract

Contract for ping events during scheduled signal monitoring.

Emitted by pingSubject every minute when a scheduled signal is being monitored. Used for tracking scheduled signal lifecycle and custom monitoring logic.

Events are emitted only when scheduled signal is active (not cancelled, not activated). Allows users to implement custom cancellation logic via onPing callback.

Consumers:

  • User callbacks via listenPing() / listenPingOnce()

Example

import { listenPing } from "backtest-kit";

// Listen to all ping events
listenPing((event) => {
  console.log(`[${event.backtest ? "Backtest" : "Live"}] Ping for ${event.symbol}`);
  console.log(`Strategy: ${event.strategyName}, Exchange: ${event.exchangeName}`);
  console.log(`Signal ID: ${event.data.id}, priceOpen: ${event.data.priceOpen}`);
  console.log(`Timestamp: ${new Date(event.timestamp).toISOString()}`);
});

// Wait for specific ping
listenPingOnce(
  (event) => event.symbol === "BTCUSDT",
  (event) => console.log("BTCUSDT ping received:", event.timestamp)
);
interface PingContract {
    backtest: boolean;
    data: IScheduledSignalRow;
    exchangeName: string;
    strategyName: string;
    symbol: string;
    timestamp: number;
}

Properties

backtest data exchangeName 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)

data

data: IScheduledSignalRow

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

exchangeName

exchangeName: string

Exchange name where this scheduled signal is being monitored. Identifies which exchange this ping event belongs to.

strategyName

strategyName: string

Strategy name that is monitoring this scheduled signal. Identifies which strategy execution this ping event belongs to.

symbol

symbol: string

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

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

Example

const eventDate = new Date(event.timestamp);
console.log(`Ping at: ${eventDate.toISOString()}`);

Settings

Member Visibility

On This Page

Properties