Interface IStrategySchema

Strategy schema registered via addStrategy(). Defines signal generation logic and configuration.

interface IStrategySchema {
    actions?: string[];
    callbacks?: Partial<IStrategyCallbacks>;
    getSignal: (
        symbol: string,
        when: Date,
        currentPrice: number,
    ) => Promise<ISignalDto>;
    interval?: SignalInterval;
    note?: string;
    riskList?: string[];
    riskName?: string;
    strategyName: string;
}

Properties

actions? callbacks? getSignal interval? note? riskList? riskName? strategyName

Properties

Optionalactions

actions?: string[]

Optional list of action identifiers to attach to this strategy

Optionalcallbacks

callbacks?: Partial<IStrategyCallbacks>

Optional lifecycle event callbacks (onOpen, onClose)

getSignal

getSignal: (
    symbol: string,
    when: Date,
    currentPrice: number,
) => Promise<ISignalDto>

Signal generation function (returns null if no signal, validated DTO if signal). If priceOpen is provided - becomes scheduled signal waiting for price to reach entry point. If priceOpen is omitted - opens immediately at current price.

Optionalinterval

interval?: SignalInterval

Minimum interval between getSignal calls (throttling)

Default: 1m

Optionalnote

note?: string

Optional developer note for documentation

OptionalriskList

riskList?: string[]

Optional several risk profile list for risk management (if multiple required)

OptionalriskName

riskName?: string

Optional risk profile identifier for risk management

strategyName

strategyName: string

Unique strategy identifier for registration

Settings

Member Visibility

On This Page

Properties