Interface PerformanceContract

Contract for performance tracking events.

Emitted during execution to track performance metrics for various operations. Useful for profiling and identifying bottlenecks.

Example

import { listenPerformance } from "backtest-kit";

listenPerformance((event) => {
  console.log(`${event.metricType}: ${event.duration.toFixed(2)}ms`);
  console.log(`${event.strategyName} @ ${event.exchangeName}`);
});
interface PerformanceContract {
    backtest: boolean;
    duration: number;
    exchangeName: string;
    metricType: PerformanceMetricType;
    previousTimestamp: number;
    strategyName: string;
    symbol: string;
    timestamp: number;
}

Properties

backtest duration exchangeName metricType previousTimestamp strategyName symbol timestamp

Properties

backtest

backtest: boolean

Whether this metric is from backtest mode (true) or live mode (false)

duration

duration: number

Duration of the operation in milliseconds

exchangeName

exchangeName: string

Exchange name associated with this metric

metricType

metricType: PerformanceMetricType

Type of operation being measured

previousTimestamp

previousTimestamp: number

Timestamp of the previous event (milliseconds since epoch, null for first event)

strategyName

strategyName: string

Strategy name associated with this metric

symbol

symbol: string

Trading symbol associated with this metric

timestamp

timestamp: number

Timestamp when the metric was recorded (milliseconds since epoch)

Settings

Member Visibility

On This Page

Properties