@qtsurfer/api-client
    Preparing search index...

    Type Alias DeclaredProperty

    One property name POST /strategy could establish without constructing the strategy — either declared with @StrategyProperty on the compiled source, or one of the small set of base properties every strategy carries (amnt, enabled, multiEntry, ...).

    Best-effort, not exhaustive. A property registered through an attached risk/backtest config needs a live instance to discover and is not listed here. Use this to catch a typo'd sweep key before submitting, not as the definitive list of what a sweep will accept — a name absent from this list may still be valid.

    type DeclaredProperty = {
        defaultValue?: string;
        description?: string;
        max?: number;
        min?: number;
        name: string;
        reflected?: boolean;
        step?: number;
    }
    Index
    defaultValue? description? max? min? name reflected? step?
    defaultValue?: string

    The declared default, as a string, if one was given. Absent, not null, when none was declared.

    description?: string

    Human-readable label, as declared.

    max?: number

    Suggested sweep/range maximum, if declared. Advisory only, never validated.

    min?: number

    Suggested sweep/range minimum, if declared. Advisory only, never validated.

    name: string

    The key a sweep or execute param map uses for this property.

    reflected?: boolean

    Whether a value for this key is injected into the strategy's field (true) or only available through the property map (false).

    step?: number

    Suggested sweep/range step, if declared. Advisory only, never validated.

    Settings
    Member Visibility

    On This Page
    Properties