Function listFrames

listFrames(): Promise<IFrameSchema[]>

Returns a list of all registered frame schemas.

Retrieves all frames that have been registered via addFrame(). Useful for debugging, documentation, or building dynamic UIs.

Returns Promise<IFrameSchema[]>

Array of frame schemas with their configurations

Example

import { listFrames, addFrame } from "backtest-kit";

addFrame({
  frameName: "1d-backtest",
  note: "One day backtest period for testing",
  interval: "1m",
  startDate: new Date("2024-01-01T00:00:00Z"),
  endDate: new Date("2024-01-02T00:00:00Z"),
});

const frames = listFrames();
console.log(frames);
// [{ frameName: "1d-backtest", note: "One day backtest...", ... }]

Function listFrames

Returns Promise<IFrameSchema[]>

Example

Settings