Function listSizings

listSizings(): Promise<ISizingSchema[]>

Returns a list of all registered sizing schemas.

Retrieves all sizing configurations that have been registered via addSizing(). Useful for debugging, documentation, or building dynamic UIs.

Returns Promise<ISizingSchema[]>

Array of sizing schemas with their configurations

Example

import { listSizings, addSizing } from "backtest-kit";

addSizing({
  sizingName: "conservative",
  note: "Low risk fixed percentage sizing",
  method: "fixed-percentage",
  riskPercentage: 1,
  maxPositionPercentage: 10,
});

addSizing({
  sizingName: "kelly",
  note: "Kelly Criterion with quarter multiplier",
  method: "kelly-criterion",
  kellyMultiplier: 0.25,
});

const sizings = listSizings();
console.log(sizings);
// [
//   { sizingName: "conservative", method: "fixed-percentage", ... },
//   { sizingName: "kelly", method: "kelly-criterion", ... }
// ]

Function listSizings

Returns Promise<ISizingSchema[]>

Example

Settings