Function listRisks

listRisks(): Promise<IRiskSchema[]>

Returns a list of all registered risk schemas.

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

Returns Promise<IRiskSchema[]>

Array of risk schemas with their configurations

Example

import { listRisks, addRisk } from "backtest-kit";

addRisk({
  riskName: "conservative",
  note: "Conservative risk management with tight position limits",
  maxConcurrentPositions: 5,
});

addRisk({
  riskName: "aggressive",
  note: "Aggressive risk management with loose limits",
  maxConcurrentPositions: 10,
});

const risks = listRisks();
console.log(risks);
// [
//   { riskName: "conservative", maxConcurrentPositions: 5, ... },
//   { riskName: "aggressive", maxConcurrentPositions: 10, ... }
// ]

Function listRisks

Returns Promise<IRiskSchema[]>

Example

Settings