Function overrideSweepSchema

  • overrideSweepSchema(sweepSchema: TSweepSchema): Promise<ISweepSchema>

    Overrides an existing sweep configuration in the framework.

    This function partially updates a previously registered sweep with new configuration. Only the provided fields will be updated, other fields remain unchanged.

    Note: the connection layer memoizes ClientSweep instances by sweep name — an override after the first run takes effect for new instances only (see SweepConnectionService.clear).

    Parameters

    • sweepSchema: TSweepSchema

      Partial sweep configuration object

      • sweepName

        Unique sweep identifier (must exist)

      • exchangeName

        Optional: Exchange to fetch candles through

      • gridAxes

        Optional: Grid axes override

      • callbacks

        Optional: Lifecycle callbacks

    Returns Promise<ISweepSchema>

    Example

    overrideSweepSchema({
      sweepName: "tv-ideas-sweep",
      gridAxes: {
        hardStopPercent: [3, 5, 7],
        trailingTakePercent: [1.5, 2, 3],
        holdMinutes: [24 * 60, 48 * 60],
      }, // Only narrow the grid
    });

Settings

Member Visibility