Function addFrame

  • addFrame(frameSchema: IFrameSchema): void

    Registers a timeframe generator for backtesting.

    The frame defines:

    • Start and end dates for backtest period
    • Interval for timeframe generation
    • Callback for timeframe generation events

    Parameters

    • frameSchema: IFrameSchema

      Frame configuration object

      Frame schema registered via addFrame(). Defines backtest period and interval for timestamp generation.

      • Optionalcallbacks?: Partial<IFrameCallbacks>

        Optional lifecycle callbacks

      • endDate: Date

        End of backtest period (inclusive)

      • frameName: string

        Unique identifier for this frame

      • interval: FrameInterval

        Interval for timestamp generation

      • Optionalnote?: string

        Optional developer note for documentation

      • startDate: Date

        Start of backtest period (inclusive)

    Returns void

    Example

    addFrame({
      frameName: "1d-backtest",
      interval: "1m",
      startDate: new Date("2024-01-01T00:00:00Z"),
      endDate: new Date("2024-01-02T00:00:00Z"),
      callbacks: {
        onTimeframe: (timeframe, startDate, endDate, interval) => {
          console.log(`Generated ${timeframe.length} timeframes`);
        },
      },
    });

Settings

Member Visibility