Function listSweepSchema

  • listSweepSchema(): Promise<ISweepSchema[]>

    Returns a list of all registered sweep schemas.

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

    Returns Promise<ISweepSchema[]>

    Array of sweep schemas with their configurations

    Example

    import { listSweepSchema, addSweepSchema } from "backtest-kit";

    addSweepSchema({
      sweepName: "tv-ideas-sweep",
      exchangeName: "ccxt-exchange",
      callbacks: {},
    });

    const sweeps = await listSweepSchema();
    console.log(sweeps);
    // [{ sweepName: "tv-ideas-sweep", exchangeName: "ccxt-exchange", ... }]

Settings

Member Visibility