Function listWorkerSchema

  • listWorkerSchema(): Promise<IWorkerSchema[]>

    Returns a list of all registered worker schemas.

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

    Returns Promise<IWorkerSchema[]>

    Array of worker schemas with their configurations

    Example

    import { listWorkerSchema, addWorkerSchema } from "backtest-kit";

    addWorkerSchema({
      workerName: "my-worker",
      live: true,
    });

    const workers = await listWorkerSchema();
    console.log(workers);
    // [{ workerName: "my-worker", live: true }]

Settings

Member Visibility