Interface IFrameSchema

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

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} timestamps`);
    },
  },
});
interface IFrameSchema {
    callbacks?: Partial<IFrameCallbacks>;
    endDate: Date;
    frameName: string;
    interval?: FrameInterval;
    note?: string;
    startDate: Date;
}

Properties

callbacks? endDate frameName interval? note? startDate

Properties

Optionalcallbacks

callbacks?: Partial<IFrameCallbacks>

Optional lifecycle callbacks

endDate

endDate: Date

End of backtest period (inclusive)

frameName

frameName: string

Unique identifier for this frame

Optionalinterval

interval?: FrameInterval

Interval for time range generation. Defaults to "1m" if not specified

Optionalnote

note?: string

Optional developer note for documentation

startDate

startDate: Date

Start of backtest period (inclusive)

Settings

Member Visibility

On This Page

Properties